gianm commented on a change in pull request #7206: Add the pull-request template URL: https://github.com/apache/incubator-druid/pull/7206#discussion_r264468750
########## 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 Review comment: There's a lot of overlap between this "Design" and the definition of a proposal: https://github.com/apache/incubator-druid/blob/master/.github/ISSUE_TEMPLATE/proposal.md. It's weird to have that template and this one talking about the same things from different angles. One way to address that is to take anything useful from this template that isn't already in the Proposal template, then merge that stuff into the Proposal template and simply reference that one here. And then open this template by saying that: 1. If you raised a proposal, just link to it. 2. If you didn't raise a proposal, think about doing that first, especially if the PR has any sort of 'interestingness' to its design that is worth discussing. If not, then include the same kind of information here in the PR. I feel that encouraging people to raise proposals is useful because it promotes separation of design-level and implementation-level discussion. One point that was raised in the dev list when we talked about this is that commingling them can cause one to drown out the other. ---------------------------------------------------------------- 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]
