clintropolis commented on a change in pull request #7206: Add the pull-request template URL: https://github.com/apache/incubator-druid/pull/7206#discussion_r264400705
########## File path: .github/pull_request_template.md ########## @@ -0,0 +1,53 @@ +Fixes #XXXX. + +(Replace XXXX with the id of the issue fixed in this PR. Remove this line if there is no corresponding +issue. Don't reference the issue in the title of this pull-request.) + +Add tags to your PR if you are a committer (only committers have the right to add tags). Add [Design Review] tag +if this PR should better be reviewed by at least two people. +Don't forget to add the following tags (if applicable): [Incompatible], [Release Notes], [Compatibility], [Security], +[Development Blocker]. Add at least one [Area - ] tag, consider creating a new one if none of the existing [Area - ] +tags is applicable. + +### Description + +Describe the goal of this PR, what problem are you fixing. If there is a corresponding issue (referenced above), it's +not necessary to repeat the description here, however, you may choose to keep one summary sentence. + +Describe your patch: what did you change in code? How did you fix the problem? + +If there are several relatively logically separate changes in this PR, list them. For example: + - Fixed the bug ... + - Renamed the class ... + - Added a forbidden-apis entry ... + +Some of the aspects mentioned above may be omitted for simple and small PRs. + +### Design + +Please describe any design decisions made, including: + - Choice of algorithms + - Behavioral aspects. What configuration values are acceptable? How are corner cases and error conditions handled, such + as when insufficient resources are available? + - Class organization and design (how the logic is split between classes, inheritance, composition, design patterns) + - Method organization and design (how the logic is split between methods, parameters and return types) + - Naming (class, method, API, configuration, HTTP endpoint, names of emitted metrics) + +In addition, describe _at least one_ alternative design (or mention alternative name) for every design (or naming) +decision point and compare the alternatives with the designs that you've implemented (or the names you've chosen). + +If you already did this in the associated issue (e. g. a "Proposal" issue), leave the following sentence: + +Design of this change is discussed [here](<link to Github issue or comment where you discuss the design>). + +This section may be omitted for really simple and small patches. However, any patch that adds a new production class +almost certainly shouldn't omit this section. + +<hr> + +I've self-reviewed this PR (including using the [concurrency checklist]( +https://github.com/leventov/java-concurrency-checklist)). + +Leave the sentence above if you've self-reviewed your PR. Leave the part in parens if your PR has any relation to Java Review comment: I wonder if instead of instructing people to leave a sentence, we should incorporate a markdown checklist we recommend people fill out, with high level things things to do, including self review, maybe something like: This PR has: - [ ] been self-reviewed ([recommended review checklist]( https://github.com/leventov/java-concurrency-checklist)). - [ ] added documentation for new or modified features or behaviors - [ ] added Javadocs to public and non-trivial members - [x] added code comments for hard to understand areas - [ ] added unit tests or modified existing tests to cover new code paths - [ ] added integration tests - [ ] been tested in a test environment - [ ] been tested in a production environment I don't know that all these things are necessary, or if anything is missing, and I think we would need to make clear that not all of these things are required. I was thinking mostly that it's a way for an author to convey to reviewers what has gone into the PR so far. We could suggest that PR authors are free to remove checks which are not applicable as well. Or maybe this is too much? I'm not sure, just throwing out ideas. ---------------------------------------------------------------- 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: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
