Contributors' Guide [ARCHIVED]

Overview

We would like to more people to use, contribute to, and maintain Airflow. These three aims align with the 3 main roles of members within our community : users, contributors, and committers/maintainers. We would like to instill a sense of ownership and pride among the members of our community by encouraging:

• people to use Airflow
• users to contribute to Airflow
• contributors to become committers

You can contribute to Airflow in many ways such as:

• reporting bugs
  • Use https://issues.apache.org/jira/browse/AIRFLOW/
• suggesting features and Road Map items
  • First subscribe to the Dev list by sending an email to dev-subscribe@airflow.incubator.apache.org – a bot will automatically subscribe you so you are white-listed to send emails to our Dev email list ( dev@airflow.incubator.apache.org ) 
  • Use Roadmap [ARCHIVED] & also email Email the Dev list
• submitting pull-requests for both bug fixes and new features
  • Use https://issues.apache.org/jira/browse/AIRFLOW/ and point it to an open Github Pull Request
• attending Airflow meet-ups
  • Check Apache Airflow Incubating Meetup
• helping in answering questions on gitter, the dev email list, PRs, and Jiras

Best Ways to Engage the Community!

There are many ways today for members of the community to connect with others in the community. These include :

• Sending an email to dev@airflow.incubator.apache.org (after registering, c.f. Contributors' Guide [ARCHIVED])
  • Best way to get a committer to answer a question
• Asking a question on https://gitter.im/apache/incubator-airflow
  • Most often, another member of the community can guide you
  • Sometimes, a committer might pop in, but it's a bit too distracting for committers to closely monitor that channel today
  • Best way to get a quick response, but may not be from a committer
• Open a JIRA when a bug is found & propose a PR with a Fix
  • Only way to get PRs approved or to report bugs

Does Your Company Use Airflow?

Details on Contributing

Getting Started

In order to contribute to Airflow, please be sure to:

• Have some questions?
  • Send emails to the dev list listed below
  • Ask question from the community on gitter
• Register on the following Apache mailing lists
  • dev@airflow.incubator.apache.org
    
    • Start by sending an email to dev-subscribe@airflow.incubator.apache.org- this will initiate an automated subscription process
    • The dev lists is where we, as a community, share information, pose and answer questions, and vote on policy changes
  • commits@airflow.incubator.apache.org
    
    • Start by sending an email to commits-subscribe@airflow.incubator.apache.org- this will initiate an automated subscription process
    • The commits list is updated by comments on Jiras and PRs and is the way you can keep abreast of discussions around Jiras.
• Sign up for both https://issues.apache.org/jira/browse/AIRFLOW and https://cwiki.apache.org/confluence/display/AIRFLOW accounts
• Visit and read docs on https://github.com/apache/incubator-airflow & Airflow Home

Submitting PRs

Note that more information as to how to setup your environment and run tests locally and on Travis-CI is available on the CONTRIBUTING.rst on Github. This document links to several other documents:

• LOCAL_VIRTUALENV.rst
• STATIC_CODE_CHECKS.rst
• BREEZE.rst
• TESTING.rst

You can follow the example workflow to learn how your workflow should look like

When filing PRs, remember to: 

• Create a JIRA for your bug fix/feature enhancement
• rebase your fork : http://stackoverflow.com/a/7244456/1110993
• squash your commits
• Preface your commit's subject & PR's title with [AIRFLOW-YYYY], where YYYY is the JIRA number, and add a JIRA link in the PR description
  • Some folks only preface the PR title with [AIRFLOW-YYYY], but we also need the commit message subject to contain the JIRA id. This is because we use the subject line in the commit messages when creating the release notes. 
• add an Apache License header to all new files (If you set-up pre-commit-hooks, this will be done automatically for you when you try to commit for the first time).
• & follow the 7 rules of good Git commits