-
Notifications
You must be signed in to change notification settings - Fork 1.7k
AVRO-3623: Update the PR template #1851
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
RyanSkraba
merged 5 commits into
apache:master
from
RyanSkraba:rskraba/AVRO-3623-PR-template
Sep 9, 2022
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
0b03f08
AVRO-3623: Update the PR template
RyanSkraba 7736b69
AVRO-3623: Replace Flink with Avro
martin-g bc95709
Update .github/PULL_REQUEST_TEMPLATE.md
RyanSkraba 35f93ae
Update PULL_REQUEST_TEMPLATE.md
RyanSkraba 26d6d1c
AVRO-3623: OK to leave comments in PR text
RyanSkraba File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,60 @@ | ||
| 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, 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 | ||
| - 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" | ||
|
|
||
| - [ ] 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 | ||
| --> | ||
|
|
||
| ## What is the purpose of the change | ||
|
|
||
| *(For example: This pull request improves file read performance by buffering data, fixing AVRO-XXXX.)* | ||
|
|
||
|
|
||
| ## Verifying this change | ||
|
|
||
| *(Please pick one of the following options)* | ||
|
|
||
| This change is a trivial rework / code cleanup without any test coverage. | ||
|
|
||
| *(or)* | ||
|
|
||
| This change is already covered by existing tests, such as *(please describe tests)*. | ||
|
|
||
| *(or)* | ||
|
|
||
| This change added tests and can be verified as follows: | ||
|
|
||
| *(example:)* | ||
| - *Extended interop tests to verify consistent valid schema names between SDKs* | ||
| - *Added test that validates that Java throws an AvroRuntimeException on invalid binary data* | ||
| - *Manually verified the change by building the website and checking the new redirect* | ||
|
|
||
|
|
||
| ## Documentation | ||
|
|
||
| - Does this pull request introduce a new feature? (yes / no) | ||
| - If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a generic way to say "Javadoc" that includes in-line code documentation like doxygen and python docs?