You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2019/12/29 20:14:29 UTC
[GitHub] [airflow] potiuk opened a new pull request #6955: [AIRFLOW-6394]
Simplify github PR template
potiuk opened a new pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955
Our Github template is not really useful for most people. Almost no-one is
marking the tick-marks when submitting the PR and not many people update the
link to the AIRFLOW ticket. I don't think it serves the purpose of teaching
people as it is too long to be actually read and acted upon
We should simplify it.
And later we should add probot checks to automate most of the stuff that we
wanted to enforce with the template
- [x] Description above provides context of the change ^^
- [x] Added JIRA to the commit/PR subject [Airflow-6394](https://issues.apache.org/jira/browse/AIRFLOW-6394)
[AIRFLOW-XXX] is ok for document-only changes
- [x] Unit tests are covering the added/modified functionality (not needed for document-only changes)
- [x] My commits follow "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
- [x] Documentation is updated as needed
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] potiuk edited a comment on issue #6955: [AIRFLOW-6394]
Simplify github PR template
Posted by GitBox <gi...@apache.org>.
potiuk edited a comment on issue #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#issuecomment-569664316
> Suggestion, as a new contributor I was at first not aware of the process for requesting reviews. I had read the contribution guidelines but it was not 100% clear to me how code review worked.
>
> I've since thought that something could be mentioned on this checklist, e.g. -
> [X] I will engage with the code review process as explained in the contribution guidelines
>
> (IMHO I also feel that the contribution guidelines should have a separate section for code review process, so it is clearer and easy to find for newbies)
Would [Contribution Workflow Example](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#contribution-workflow-example) work @baolsen? We've added it recently as part of GSOD changes.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] dimberman commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
dimberman commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361881680
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,5 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
+- [ ] Description above provides context of the change ^^
+- [ ] Commit message contains [\[AIRFLOW-XXXX\]](https://issues.apache.org/jira/browse/AIRFLOW-XXXX) or [AIRFLOW-XXXX] for document-only changes
+- [ ] Unit tests cover the change (not for document-only changes)
Review comment:
"Unit tests for all changes (for non-documentation changes)"
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] dimberman commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
dimberman commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361881652
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,5 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
+- [ ] Description above provides context of the change ^^
+- [ ] Commit message contains [\[AIRFLOW-XXXX\]](https://issues.apache.org/jira/browse/AIRFLOW-XXXX) or [AIRFLOW-XXXX] for document-only changes
Review comment:
One big benefit of putting the JIRA number in this section is that it gives me a link that I can easily click to see the JIRA page. Would it be possible to make/use a git bot that pulls the JIRA number and comments a link in the PR?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] potiuk commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361915128
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,5 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
Review comment:
Right. Added at the bottom.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] potiuk commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361912621
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,5 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
+- [ ] Description above provides context of the change ^^
+- [ ] Commit message contains [\[AIRFLOW-XXXX\]](https://issues.apache.org/jira/browse/AIRFLOW-XXXX) or [AIRFLOW-XXXX] for document-only changes
+- [ ] Unit tests cover the change (not for document-only changes)
+- [ ] Commits follow "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
+- [ ] Documentation is updated when needed
Review comment:
Remove "when needed" and replaced it with " Relevant Documentation is updated including usage instructions." I think that might be better. Still we have review process that we can point out to the missing bits.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] potiuk commented on issue #6955: [AIRFLOW-6394] Simplify
github PR template
Posted by GitBox <gi...@apache.org>.
potiuk commented on issue #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#issuecomment-569539626
I removed some more unneeded words :)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] potiuk commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361972306
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,9 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
+- [ ] Description above provides context of the change
+- [ ] Commit message contains [\[AIRFLOW-XXXX\]](https://issues.apache.org/jira/browse/AIRFLOW-XXXX) or `[AIRFLOW-XXXX]` for document-only changes
Review comment:
It's super useful to have the link here so that we can quickly move to the JIRA issue. We can do it with probot likely but now some manual entry is needed I am afraid :(
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] potiuk commented on issue #6955: [AIRFLOW-6394] Simplify
github PR template
Posted by GitBox <gi...@apache.org>.
potiuk commented on issue #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#issuecomment-569604689
I updated the template after the comments. Please re-review :). You can see how such PR will look like above - I updated PR description according to the updated template.
I think it's much cleaner and actually actionable and more readable and useful (comparing to the old one). Let me know if you are happy with it !
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] milton0825 commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
milton0825 commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361895262
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,5 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
Review comment:
I think this is a useful information to keep so that users are aware of this requirement.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] potiuk commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361914653
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,5 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
Review comment:
Agree!. Added licence information (also as a note at the bottom without checkmark).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] potiuk commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361912684
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,5 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
+- [ ] Description above provides context of the change ^^
+- [ ] Commit message contains [\[AIRFLOW-XXXX\]](https://issues.apache.org/jira/browse/AIRFLOW-XXXX) or [AIRFLOW-XXXX] for document-only changes
+- [ ] Unit tests cover the change (not for document-only changes)
Review comment:
Yep
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] potiuk commented on issue #6955: [AIRFLOW-6394] Simplify
github PR template
Posted by GitBox <gi...@apache.org>.
potiuk commented on issue #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#issuecomment-569664316
> Suggestion, as a new contributor I was at first not aware of the process for requesting reviews. I had read the contribution guidelines but it was not 100% clear to me how code review worked.
>
> I've since thought that something could be mentioned on this checklist, e.g. -
> [X] I will engage with the code review process as explained in the contribution guidelines
>
> (IMHO I also feel that the contribution guidelines should have a separate section for code review process, so it is clearer and easy to find for newbies)
Would [Contribution Workflow Example](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#contribution-workflow-example) work @baolsen. We've added it recently as part of GSOD changes?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] baolsen commented on issue #6955: [AIRFLOW-6394] Simplify
github PR template
Posted by GitBox <gi...@apache.org>.
baolsen commented on issue #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#issuecomment-569633494
Suggestion, as a new contributor I was at first not aware of the process for requesting reviews. I had read the contribution guidelines but it was not 100% clear to me how code review worked.
I've since thought that something could be mentioned on this checklist, e.g. -
[X] I will engage with the code review process as explained in the contribution guidelines
(IMHO I also feel that the contribution guidelines should have a separate section for code review process, so it is clearer and easy to find for newbies)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] nuclearpinguin commented on a change in pull request
#6955: [AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
nuclearpinguin commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361936336
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,9 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
+- [ ] Description above provides context of the change
+- [ ] Commit message contains [\[AIRFLOW-XXXX\]](https://issues.apache.org/jira/browse/AIRFLOW-XXXX) or `[AIRFLOW-XXXX]` for document-only changes
Review comment:
Am I right that when opening a PR I have to input JIRA number two times? I think it's redundant
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] dimberman commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
dimberman commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361881680
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,5 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
+- [ ] Description above provides context of the change ^^
+- [ ] Commit message contains [\[AIRFLOW-XXXX\]](https://issues.apache.org/jira/browse/AIRFLOW-XXXX) or [AIRFLOW-XXXX] for document-only changes
+- [ ] Unit tests cover the change (not for document-only changes)
Review comment:
"Unit tests coverage for changes (not needed for documentation changes)"
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] potiuk commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361971985
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,9 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
+- [ ] Description above provides context of the change
+- [ ] Commit message contains [\[AIRFLOW-XXXX\]](https://issues.apache.org/jira/browse/AIRFLOW-XXXX) or `[AIRFLOW-XXXX]` for document-only changes
Review comment:
@nuclearpinguin. I tried to simplify it indeed but do not know how. Any idea how to make it not redundant before we employ probot ?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] milton0825 commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
milton0825 commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361895065
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,5 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
+- [ ] Description above provides context of the change ^^
Review comment:
Or PR description should provide context of the change
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] potiuk commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361912002
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,5 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
+- [ ] Description above provides context of the change ^^
+- [ ] Commit message contains [\[AIRFLOW-XXXX\]](https://issues.apache.org/jira/browse/AIRFLOW-XXXX) or [AIRFLOW-XXXX] for document-only changes
Review comment:
Yes. I think we should do it when we add probot :). I even mentioned that in the PR description ;) @dimberman.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] mik-laj commented on issue #6955: [AIRFLOW-6394] Simplify
github PR template
Posted by GitBox <gi...@apache.org>.
mik-laj commented on issue #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#issuecomment-569550473
I think it is worth keeping the requirement to add a link to JIRA in the description.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] kaxil commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361887688
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,5 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
+- [ ] Description above provides context of the change ^^
+- [ ] Commit message contains [\[AIRFLOW-XXXX\]](https://issues.apache.org/jira/browse/AIRFLOW-XXXX) or [AIRFLOW-XXXX] for document-only changes
+- [ ] Unit tests cover the change (not for document-only changes)
+- [ ] Commits follow "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
+- [ ] Documentation is updated when needed
Review comment:
"when needed" is too broad and most of them will ignore it :-D as it might not be needed according to them.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] BasPH commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
BasPH commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361870073
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,6 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
+- [ ] Description above provides context of the change ^^
+- [ ] Added JIRA to the commit/PR subject [Airflow-XXXX](https://issues.apache.org/jira/browse/AIRFLOW-XXXX)
Review comment:
```suggestion
- [ ] Added JIRA to the commit/PR subject [AIRFLOW-XXXX](https://issues.apache.org/jira/browse/AIRFLOW-XXXX)
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] potiuk commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361914198
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,5 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
Review comment:
I added information (not a tick-mark) about AIP. That's useful. The rest is just redundant with "Commit message contains [\[AIRFLOW-XXXX\]](https://issues.apache.org/jira/browse/AIRFLOW-XXXX) or `[AIRFLOW-XXXX]` for document-only changes" I think.
One of the goals of that change was to fit every description in one line of github comment and to fit everything in the default size of the PR description box. It's pretty much guaranteed it will not be read if it's longer/multi-line and we can always explain it during review process if someone did not understand it (plus we have very nice description in CONTRIBUTING.md that we can refer people to). I actually added a line with link to contributing now.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] potiuk commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361911831
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,5 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
+- [ ] Description above provides context of the change ^^
Review comment:
@milton0825 -> in most cases when you provide a good commit message, the description from the commit will be automatically added at the beginning. That's why I mention "Description above" :). So you can either have it in the commit already (and it will be added) or you should add it above the checkmark. I think it makes perfect sense and is natural?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] nuclearpinguin commented on a change in pull request
#6955: [AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
nuclearpinguin commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361877839
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,5 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
+- [ ] Description above provides context of the change ^^
Review comment:
```suggestion
- [ ] Description above provides context of the change
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] kaxil merged pull request #6955: [AIRFLOW-6394] Simplify
github PR template
Posted by GitBox <gi...@apache.org>.
kaxil merged pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] milton0825 commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
milton0825 commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361895396
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,5 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
Review comment:
I think this is also useful information that we should keep
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] mik-laj edited a comment on issue #6955: [AIRFLOW-6394]
Simplify github PR template
Posted by GitBox <gi...@apache.org>.
mik-laj edited a comment on issue #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#issuecomment-569550473
I think it is worth keeping the requirement to add a link to JIRA in the description. Now it is not very clear because it is in the middle of a sentence.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] kaxil commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361992084
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,9 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
-
-### Description
-
-- [ ] Here are some details about my PR, including screenshots of any UI changes:
-
-### Tests
-
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
-
-### Commits
-
-- [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, 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
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
-
-### Documentation
-
-- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- - All the public functions and the classes in the PR contain docstrings that explain what it does
- - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
+- [ ] Description above provides context of the change
+- [ ] Commit message contains [\[AIRFLOW-XXXX\]](https://issues.apache.org/jira/browse/AIRFLOW-XXXX) or `[AIRFLOW-XXXX]` for document-only changes
Review comment:
I think it is fine, generally, you just copy/paste it. Just 1 more paste :)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] nuclearpinguin commented on issue #6955: [AIRFLOW-6394]
Simplify github PR template
Posted by GitBox <gi...@apache.org>.
nuclearpinguin commented on issue #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#issuecomment-569551546
> I think it is worth keeping the requirement to add a link to JIRA in the description. Now it is not very clear because it is in the middle of a sentence.
I agree and moreover we have to adjust XXXX two times?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] milton0825 commented on a change in pull request #6955:
[AIRFLOW-6394] Simplify github PR template
Posted by GitBox <gi...@apache.org>.
milton0825 commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#discussion_r361895317
##########
File path: .github/PULL_REQUEST_TEMPLATE.md
##########
@@ -1,33 +1,5 @@
-Make sure you have checked _all_ steps below.
-
-### Jira
-
-- [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- - https://issues.apache.org/jira/browse/AIRFLOW-XXX
- - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
Review comment:
Same here. I think this is something useful that we should keep it here to inform users.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] potiuk edited a comment on issue #6955: [AIRFLOW-6394]
Simplify github PR template
Posted by GitBox <gi...@apache.org>.
potiuk edited a comment on issue #6955: [AIRFLOW-6394] Simplify github PR template
URL: https://github.com/apache/airflow/pull/6955#issuecomment-569664316
> Suggestion, as a new contributor I was at first not aware of the process for requesting reviews. I had read the contribution guidelines but it was not 100% clear to me how code review worked.
>
> I've since thought that something could be mentioned on this checklist, e.g. -
> [X] I will engage with the code review process as explained in the contribution guidelines
>
> (IMHO I also feel that the contribution guidelines should have a separate section for code review process, so it is clearer and easy to find for newbies)
Would [Contribution Workflow Example](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#contribution-workflow-example) work @baolsen. We've added it recently as part of GSOD changes?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services