You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by GitBox <gi...@apache.org> on 2019/06/06 14:29:30 UTC

[GitHub] [incubator-druid] egor-ryashin commented on a change in pull request #7206: Add the pull-request template

egor-ryashin commented on a change in pull request #7206: Add the pull-request template
URL: https://github.com/apache/incubator-druid/pull/7206#discussion_r291205498
 
 

 ##########
 File path: .github/pull_request_template.md
 ##########
 @@ -0,0 +1,65 @@
+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.)
+
+(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 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:
+#### 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 insufficient resources are available?
 
 Review comment:
   I would rephrase "as when there are insufficient resources" or "when not enough resources are available".

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org