This is an automated email from the ASF dual-hosted git repository.
asdf2014 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-druid.git
The following commit(s) were added to refs/heads/master by this push:
new 399b3ad Hide descriptive comments (#8313)
399b3ad is described below
commit 399b3ad7de14e2029294ac418a82b17ca108a869
Author: Benedict Jin <asdf2...@apache.org>
AuthorDate: Fri Aug 16 10:08:34 2019 +0800
Hide descriptive comments (#8313)
---
.github/pull_request_template.md | 27 +++++++++++++++------------
1 file changed, 15 insertions(+), 12 deletions(-)
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index e648b40..6bb2c5d 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,36 +1,39 @@
-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.
+<!-- 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 this section 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?
+<!-- 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?
- 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.
-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 [...]
+<!-- 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. -->
-Some of the aspects mentioned above may be omitted for simple and small
changes.
+<!-- 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 d [...]
+
+<!-- Some of the aspects mentioned above may be omitted for simple and small
changes. -->
<hr>
@@ -44,11 +47,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>
##### Key changed/added classes in this PR
* `MyFoo`
* `OurBar`
- * `TheirBaz`
\ No newline at end of file
+ * `TheirBaz`
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@druid.apache.org
For additional commands, e-mail: commits-h...@druid.apache.org
