The document outlines the steps to contribute to the Apache Airflow project:
1. Fork the Apache Airflow repository and configure your development environment.
2. Connect with the Apache Airflow community by joining communication channels like Slack and mailing lists.
3. Prepare a pull request with your code changes by following the pull request guidelines and rebasing regularly.
4. Engage in peer review by pinging reviewers on Slack and addressing any comments to get your pull request merged.
3. Polidea
How to contribute
1
Fork airflow/master
Make your own fork of Apache
Airflow main repo
Configure environment
Create virtualenv
Initialize Breeze
Install pre-commit
Setup your own Travis CI
2
Connect with people
Join devlist
Setup slack account
3
Prepare PR
PR from your fork
Follow PR guidelines in
CONTRIBUTING.rst
4
PR review
Ping @ #development slack
Comment @people
Be annoying
Be considerate
5
4. Polidea
Fork apache/airflow
● Apache Airflow repository
○ https://github.com/apache/airflow
● How to fork
○ https://help.github.com/en/github/getting-started-with-github/fork-a-repo
6. Polidea
Configure environment
● Dev environments:
○ https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#development-environments
● Local virtualenv:
○ https://github.com/apache/airflow/blob/master/LOCAL_VIRTUALENV.rst
● Breeze
○ https://github.com/apache/airflow/blob/master/BREEZE.rst
● Travis CI
○ https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#travis-ci-testing-framework
● Pre-commit hooks
○ https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pre-commit-hooks
7. Polidea
Connect with people
● Slack: ad-hoc discussions/ask questions/is anyone working on it?
● DevList: important topics
● https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#resources-links
● Mailing lists:
○ Developer’s mailing list mailto:dev-subscribe@airflow.apache.org
○ All commits mailing list: mailto:commits-subscribe@airflow.apache.org
○ Airflow users mailing list: mailto:users-subscribe@airflow.apache.org
● Issues on Apache’s Jira
● Slack (chat)
● More resources and links to Airflow related content on the Wiki
8. Polidea
Prepare PR
● Pull Request Guidelines
○ https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#id11
● Rebase your fork, squash commits, and resolve all conflicts.
● Preface your commit's subject & PR title with [AIRFLOW-YYYY]
COMMIT_MSG where YYYY is the JIRA number.
9. Polidea
Check for PR
reviews and
comments
Apply fixes
and extend
tests
Submit
fixup
commit
Ping on
#developme
nt
PR Review
● Be empathic
● Be annoying
● Be cooperative
● Be persistent
● Rebase often to master
● Rinse & repeat
