Contributors' Guide

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
  • Use Roadmap & 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

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

• When filing PRs, remember to 
  • rebase your fork : http://stackoverflow.com/a/7244456/1110993
  • squash your commits
  • Create a JIRA for your bug fix/feature enhancement - point the JIRA "External Issue URL" to your PR URL
  • Preface your commit's subject & PR's title with [AIRFLOW-XXX], where XXX is the JIRA number, and add a JIRA link in the PR description
    • Some folks just preface the PR title with [AIRFLOW-XXX], but we need the commit message subject to contain the JIRA id
  • add an Apache License header to all new files
  • & follow the 7 rules of good Git commits