forked from apache/airflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[AIRFLOW-995][AIRFLOW-1] Update GitHub PR Template
Closes apache#2160 from jlowin/PR-template
- Loading branch information
Showing
1 changed file
with
34 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,35 @@ | ||
| Please accept this PR that addresses the following issues: | ||
| - *(MANDATORY - replace with a link to JIRA - e.g. https://issues.apache.org/jira/browse/AIRFLOW-XXX)* | ||
|
|
||
| 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 (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! | ||
|
|
||
| * For all PRs with UI changes, you must provide screenshots. If the UI changes are not obvious, either annotate the images or provide before/after screenshots. | ||
|
|
||
| * 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 | ||
| Dear Airflow maintainers, | ||
|
|
||
| Please accept this PR. I understand that it will not be reviewed until I have checked off all the steps below! | ||
|
|
||
| ### Opened PR | ||
| - [x] Opened a PR on Github | ||
|
|
||
|
|
||
| ### [JIRA](https://issues.apache.org/jira/browse/AIRFLOW/) | ||
| - [ ] My PR addresses the following Airflow JIRA issues: | ||
| - https://issues.apache.org/jira/browse/AIRFLOW-XXX | ||
| - [ ] The PR title references the JIRA issues. For example, "[AIRFLOW-1] My Airflow PR" | ||
|
|
||
|
|
||
| ### Tests | ||
| - [ ] My PR adds unit tests | ||
| - [ ] __OR__ my PR does not need testing for this extremely good reason: | ||
|
|
||
|
|
||
| ### Description | ||
| - [ ] Here are some details about my PR: | ||
| - [ ] Here are screenshots of any UI changes, if appropriate: | ||
|
|
||
|
|
||
| ### Commits | ||
| - [ ] Each commit subject references a JIRA issue. For example, "[AIRFLOW-1] Add new feature" | ||
| - [ ] Multiple commits addressing the same JIRA issue have been squashed | ||
| - [ ] My commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)": | ||
| 1. Subject is separated from body by a blank line | ||
| 2. Subject is limited to 50 characters | ||
| 3. Subject does not end with a period | ||
| 4. Subject uses the imperative mood ("add", not "adding") | ||
| 5. Body wraps at 72 characters | ||
| 6. Body explains "what" and "why", not "how" | ||
|
|