[GitHub] [airflow] potiuk commented on a change in pull request #6955: [AIRFLOW-6394] Simplify github PR template
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:
us...@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
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-\]](https://issues.apache.org/jira/browse/AIRFLOW-) or
[AIRFLOW-] 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:
us...@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
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-\]](https://issues.apache.org/jira/browse/AIRFLOW-) or
[AIRFLOW-] 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:
us...@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
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-\]](https://issues.apache.org/jira/browse/AIRFLOW-) or
[AIRFLOW-] 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:
us...@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
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-\]](https://issues.apache.org/jira/browse/AIRFLOW-) or `[AIRFLOW-]` 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: us...@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
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: us...@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
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:
us...@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
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-\]](https://issues.apache.org/jira/browse/AIRFLOW-) or
`[AIRFLOW-]` 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:
us...@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
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-\]](https://issues.apache.org/jira/browse/AIRFLOW-) or
`[AIRFLOW-]` 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:
us...@infra.apache.org
With regards,
Apache Git Services
