Apache
/
druid
mirror of https://github.com/apache/druid.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

more adjustments to PR template (#8048) 

* more adjustments

* friendly thanks, remove italics, change key changed/added to list
This commit is contained in:
Clint Wylie 2019-08-07 13:17:47 -07:00 committed by Gian Merlino
parent 05b44e3467
commit 172ebba4b8
1 changed files with 16 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
.github/pull_request_template.md vendored
View File

@ -1,41 +1,34 @@
Thanks for trying to help us make Apache Druid (incubating) be the best it can be! Please fill out as much of the following information as is possible (where relevant, and remove it when irrelevant) to help make the intention and scope of this PR clear in order to ease review.
Fixes #XXXX.
(Replace XXXX with the id of the issue fixed in this PR. Remove the above line if there is no corresponding
issue. Don't reference the issue in the title of this pull-request.)
Replace XXXX with the id of the issue fixed in this PR. Remove this section if there is no corresponding issue. Don't reference the issue in the title of this pull-request.
(If you are a committer, follow the PR action item checklist for committers:
https://github.com/apache/incubator-druid/blob/master/dev/committer-instructions.md#pr-and-issue-action-item-checklist-for-committers.)
If you are a committer, follow the PR action item checklist for committers:
https://github.com/apache/incubator-druid/blob/master/dev/committer-instructions.md#pr-and-issue-action-item-checklist-for-committers.
### 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 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, create a mini-section for each of them. For
example:
If there are several relatively logically separate changes in this PR, create a mini-section for each of them. For example:
#### Fixed the bug ...
#### Renamed the class ...
#### Added a forbidden-apis entry ...
In each section, please describe 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 there are insufficient resources?
- Behavioral aspects. What configuration values are acceptable? How are corner cases and error conditions handled, such as when there are insufficient resources?
- 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)
It's good to describe an alternative design (or mention an 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) to highlight the
advantages of the chosen designs and names.
It's good to describe an alternative design (or mention an 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) to highlight the advantages of the chosen designs and names.
If there was a discussion of the design of the feature implemented in this PR elsewhere (e. g. a "Proposal" issue, any
other issue, or a thread in the development mailing list), link to that discussion from this PR description and explain
what have changed in your final design compared to your original proposal or the consensus version in the end of the
discussion. If something hasn't changed since the original discussion, you can omit a detailed discussion of those
aspects of the design here, perhaps apart from brief mentioning for the sake of readability of this PR description.
If there was a discussion of the design of the feature implemented in this PR elsewhere (e. g. a "Proposal" issue, any other issue, or a thread in the development mailing list), link to that discussion from this PR description and explain what have changed in your final design compared to your original proposal or the consensus version in the end of the discussion. If something hasn't changed since the original discussion, you can omit a detailed discussion of those aspects of the design here, perhaps apart from brief mentioning for the sake of readability of this PR description.
Some of the aspects mentioned above may be omitted for simple and small changes.
@ -51,12 +44,11 @@ This PR has:
- [ ] added integration tests.
- [ ] been tested in a test Druid cluster.
Check the items by putting "x" in the brackets for the done things. Not all of these items apply to every PR. Remove the
items which are not done or not relevant to the PR. None of the items from the checklist above are strictly necessary,
but it would be very helpful if you at least self-review the PR.
Check the items by putting "x" in the brackets for the done things. Not all of these items apply to every PR. Remove the items which are not done or not relevant to the PR. None of the items from the checklist above are strictly necessary, but it would be very helpful if you at least self-review the PR.
<hr>
For reviewers: the key changed/added classes in this PR are `MyFoo`, `OurBar`, and `TheirBaz`.
(Add this section in big PRs to ease navigation in them for reviewers.)
##### Key changed/added classes in this PR
* `MyFoo`
* `OurBar`
* `TheirBaz`