You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by bo...@apache.org on 2016/06/28 19:05:26 UTC
[1/2] incubator-airflow git commit: [AIRFLOW-275] Update contributing
guidelines
Repository: incubator-airflow
Updated Branches:
refs/heads/master d15f8ca37 -> 02a2076a7
[AIRFLOW-275] Update contributing guidelines
The current guidelines do not reflect the move to Apache. This
updates the links and update the PR template.
Project: http://git-wip-us.apache.org/repos/asf/incubator-airflow/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-airflow/commit/5364d6cf
Tree: http://git-wip-us.apache.org/repos/asf/incubator-airflow/tree/5364d6cf
Diff: http://git-wip-us.apache.org/repos/asf/incubator-airflow/diff/5364d6cf
Branch: refs/heads/master
Commit: 5364d6cf024390172c398a56ca3baf71dba4f360
Parents: f4c4414
Author: Bolke de Bruin <bo...@xs4all.nl>
Authored: Thu Jun 23 21:36:17 2016 +0200
Committer: Bolke de Bruin <bo...@xs4all.nl>
Committed: Thu Jun 23 21:36:17 2016 +0200
----------------------------------------------------------------------
.github/ISSUE_TEMPLATE.md | 36 -----------------------------------
.github/PULL_REQUEST_TEMPLATE.md | 21 +++++++++++++++++---
CONTRIBUTING.md | 35 ++++++++++++++++++++++++++--------
3 files changed, 45 insertions(+), 47 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-airflow/blob/5364d6cf/.github/ISSUE_TEMPLATE.md
----------------------------------------------------------------------
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index cbda0fd..0000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,36 +0,0 @@
-Dear Airflow Maintainers,
-
-### Environment
-
-Before I tell you about my issue, let me describe my Airflow environment:
-
-*Please fill out any appropriate fields:*
-* Airflow version: *(release number or `git log --oneline | head -n 3`)*
-* Airflow components: *(e.g. "webserver and scheduler with a postgres database and LocalExecutor")*
-* Relevant `airflow.cfg` settings:
-* Python Version: *(`python --version`)*
-* Operating System: *(Windows version or `uname -a`)*
-* Python packages: *(`pip freeze` or `conda list`)*
-
-
-### Description of Issue
-
-Now that you know a little about me, let me tell you about the issue I am having:
-
-* What did you expect to happen?
-* What happened instead?
-* Screen shots of your DAG's graph and tree views, if appropriate:
-* Stack trace, if appropriate:
-
-### Reproducing the Issue
-
-Here is how you can reproduce this issue on your machine.
-
-* Example code that reproduces the issue, including a minimally illustrative DAG if necessary:
-
-* Reproduction steps:
-
-1.
-2.
-3.
-
http://git-wip-us.apache.org/repos/asf/incubator-airflow/blob/5364d6cf/.github/PULL_REQUEST_TEMPLATE.md
----------------------------------------------------------------------
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 724a866..3e497bd 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -3,8 +3,23 @@ Dear Airflow Maintainers,
Please accept this PR that addresses the following issues:
- *(replace with a link to AIRFLOW-X)*
+Per Apache guidelines you need to create a [Jira issue](https://issues.apache.org/jira/browse/AIRFLOW/).
+
Testing Done:
+- Unittests are required, if you do not include new unit tests please
+specify why you think this is not required. We like to improve our
+coverage so a non existing test is even a better reason to include one.
-Reminders for contributors:
-* Your PR's title must reference an issue on [Airflow's JIRA](https://issues.apache.org/jira/browse/AIRFLOW/). For example, a PR called "[AIRFLOW-1] My Amazing PR" would close JIRA issue #1. Please open a new issue if required!
-* Please squash your commits when possible and follow the [7 rules of good Git commits](http://chris.beams.io/posts/git-commit/#seven-rules).
+Reminders for contributors (REQUIRED!):
+* Your PR's title must reference an issue on
+[Airflow's JIRA](https://issues.apache.org/jira/browse/AIRFLOW/).
+For example, a PR called "[AIRFLOW-1] My Amazing PR" would close JIRA
+issue #1. Please open a new issue if required!
+* Please squash your commits when possible and follow the [How to write a good git commit message](http://chris.beams.io/posts/git-commit/).
+Summarized as follows:
+ 1. Separate subject from body with a blank line
+ 2. Limit the subject line to 50 characters
+ 3. Do not end the subject line with a period
+ 4. Use the imperative mood in the subject line (add, not adding)
+ 5. Wrap the body at 72 characters
+ 6. Use the body to explain what and why vs. how
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow/blob/5364d6cf/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e5a0455..c0c2288 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -24,15 +24,16 @@ little bit helps, and credit will always be given.
### Report Bugs
-Report bugs through Github
+Report bugs through [Apache Jira](https://issues.apache.org/jira/browse/AIRFLOW)
-We now provide a [templated issue form](https://github.com/airbnb/airflow/blob/master/.github/ISSUE_TEMPLATE.md). You must provide information for all required fields else the bug will be closed.
+Please report relevant information and preferably code that exhibits
+the problem.
### Fix Bugs
-Look through the GitHub issues for bugs. Anything tagged with "bug" is
-open to whoever wants to implement it.
+Look through the Jira issues for bugs. Anything is open to whoever wants
+to implement it.
### Implement Features
@@ -64,7 +65,9 @@ If you are proposing a feature:
## Documentation
-The latest API documentation is usually available [here](http://pythonhosted.org/airflow). To generate a local version, you need to have installed airflow with the `doc` extra. In that case you can generate the doc by running:
+The latest API documentation is usually available [here](http://pythonhosted.org/airflow).
+To generate a local version, you need to have installed airflow with
+the `doc` extra. In that case you can generate the doc by running:
cd docs && ./build.sh
@@ -87,7 +90,11 @@ Before you submit a pull request from your forked repo, check that it
meets these guidelines:
1. The pull request should include tests, either as doctests, unit tests, or
-both. The airflow repo uses [Travis CI](https://travis-ci.org/airbnb/airflow) to run the tests and [coveralls](https://coveralls.io/github/airbnb/airflow) to track coverage. You can set up both for free on your fork. It will help you making sure you do not break the build with your PR and that you help increase coverage.
+both. The airflow repo uses [Travis CI](https://travis-ci.org/apache/incubator-airflow)
+to run the tests and [codecov](https://codecov.io/gh/apache/incubator-airflow)
+to track coverage. You can set up both for free on your fork. It will
+help you making sure you do not break the build with your PR and that you help
+increase coverage.
2. If the pull request adds functionality, the docs should be updated as part
of the same PR. Doc string are often sufficient. Make sure to follow the
sphinx compatible standards.
@@ -95,8 +102,18 @@ sphinx compatible standards.
writing code that works in both Python 2 and 3, see the documentation at the
[Python-Future project](http://python-future.org) (the future package is an
Airflow requirement and should be used where possible).
-4. As Airflow grows as a project, we try to enforce a more consistent style and try to follow the Python community guidelines. We track this using [landscape.io](https://landscape.io/github/airbnb/airflow/), which you can setup on your fork as well to check before you submit your PR. We currently enforce most [PEP8](https://www.python.org/dev/peps/pep-0008/) and a few other linting rules. It is usually a good idea to lint locally as well using [flake8](https://flake8.readthedocs.org/en/latest/) using `flake8 airflow tests`
+4. As Airflow grows as a project, we try to enforce a more consistent
+style and try to follow the Python community guidelines. We track this
+using [landscape.io](https://landscape.io/github/apache/incubator-airflow/),
+which you can setup on your fork as well to check before you submit your
+PR. We currently enforce most [PEP8](https://www.python.org/dev/peps/pep-0008/)
+and a few other linting rules. It is usually a good idea to lint locally
+as well using [flake8](https://flake8.readthedocs.org/en/latest/)
+using `flake8 airflow tests`
5. Please rebase and resolve all conflicts before submitting.
+6. Please read this excellent [article](http://chris.beams.io/posts/git-commit/) on
+commit messages and adhere to them. It makes the lives of those who
+come after you a lot easier.
### Testing locally
@@ -107,7 +124,9 @@ Tests can then be run with (see also the [Running unit tests](#running-unit-test
#### Running unit tests
-We *highly* recommend setting up [Travis CI](https://travis-ci.org/) on your repo to automate this. It is free for open source projects. If for some reason you cannot, you can use the steps below to run tests.
+We *highly* recommend setting up [Travis CI](https://travis-ci.org/) on
+your repo to automate this. It is free for open source projects. If for
+some reason you cannot, you can use the steps below to run tests.
Here are loose guidelines on how to get your environment to run the unit tests.
We do understand that no one out there can run the full test suite since
[2/2] incubator-airflow git commit: Merge branch 'contributing'
Posted by bo...@apache.org.
Merge branch 'contributing'
Project: http://git-wip-us.apache.org/repos/asf/incubator-airflow/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-airflow/commit/02a2076a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-airflow/tree/02a2076a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-airflow/diff/02a2076a
Branch: refs/heads/master
Commit: 02a2076a76f5fe17fdcbca7e59bcc76a92b7c3a5
Parents: d15f8ca 5364d6c
Author: Bolke de Bruin <bo...@xs4all.nl>
Authored: Tue Jun 28 21:04:57 2016 +0200
Committer: Bolke de Bruin <bo...@xs4all.nl>
Committed: Tue Jun 28 21:04:57 2016 +0200
----------------------------------------------------------------------
.github/ISSUE_TEMPLATE.md | 36 -----------------------------------
.github/PULL_REQUEST_TEMPLATE.md | 21 +++++++++++++++++---
CONTRIBUTING.md | 35 ++++++++++++++++++++++++++--------
3 files changed, 45 insertions(+), 47 deletions(-)
----------------------------------------------------------------------