[GitHub] [avro] clesaec commented on a diff in pull request #1851: AVRO-3623: Update the PR template

[GitBox <gi...@apache.org>]

clesaec commented on code in PR #1851:
URL: https://github.com/apache/avro/pull/1851#discussion_r961442928


##########
.github/PULL_REQUEST_TEMPLATE.md:
##########
@@ -1,26 +1,62 @@
-Make sure you have checked _all_ steps below.
+<!--
 
-### Jira
+*Thank you very much for contributing to Apache Avro - we are happy that you want to help us improve Avro. To help the community review your contribution in the best possible way, please go through the checklist below, which will get the contribution into a shape in which it can be best reviewed.*
 
-- [ ] My PR addresses the following [Avro Jira](https://issues.apache.org/jira/browse/AVRO/) issues and references them in the PR title. For example, "AVRO-1234: My Avro PR"
-  - https://issues.apache.org/jira/browse/AVRO-XXX
-  - 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).
+*Please understand that we do not do this to make contributions to Avro a hassle. In order to uphold a high standard of quality for code contributions, while at the same time managing a large number of contributions, we need contributors to prepare the contributions well, and give reviewers enough contextual information for the review. Please also understand that contributions that do not follow this guide will take longer to review and thus typically be picked up with lower priority by the community.*
 
-### Tests
+## Contribution Checklist
 
-- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
+  - Make sure that the pull request corresponds to a [JIRA issue](https://issues.apache.org/jira/projects/AVRO/issues). Exceptions are made for typos in JavaDoc or documentation files, which need no JIRA issue.
+  
+  - Name the pull request in the form "AVRO-XXXX: [component] Title of the pull request", where *AVRO-XXXX* should be replaced by the actual issue number. 
+    The *component* is optional, and but can help identify the correct reviewers faster: either the language ("java", "python") or subsystem such as "build" or "doc" are good candidates.  
 
-### Commits
+  - Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
+  
+  - Make sure that the change passes the automated tests. You can [build the entire project](https://github.com/apache/avro/blob/master/BUILD.md) or just the [language-specific SDK](https://avro.apache.org/project/how-to-contribute/#unit-tests).
 
-- [ ] My commits all reference Jira issues in their subject lines. In addition, my commits follow the guidelines from "[How to write a good git commit message](https://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"
+  - Each pull request should address only one issue, not mix up code from multiple issues.
+  
+  - Each commit in the pull request has a meaningful commit message (including the JIRA id)
 
-### Documentation
+  - Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
 
-- [ ] 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 Javadoc that explain what it does
+  - Every commit message references Jira issues in their subject lines. In addition, commits follow the guidelines from [How to write a good git commit message](https://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"
+
+-->
+
+## What is the purpose of the change
+
+*(For example: This pull request improves file read performance by buffering data.)*

Review Comment:
   May add here explicit JIRA link if exists.



-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org