You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by jo...@apache.org on 2019/03/06 00:06:46 UTC
[incubator-druid] branch master updated: Adjust issue templates
(#7188)
This is an automated email from the ASF dual-hosted git repository.
jonwei 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 37cbad7 Adjust issue templates (#7188)
37cbad7 is described below
commit 37cbad79b175c5be9620566c5f5a976cd50b2e6c
Author: Roman Leventov <le...@gmail.com>
AuthorDate: Tue Mar 5 21:06:40 2019 -0300
Adjust issue templates (#7188)
* Adjust issue templates
* typo
* bug -> problem
---
.github/ISSUE_TEMPLATE/feature.md | 22 ++++++++++++++++++++++
.github/ISSUE_TEMPLATE/feature_request.md | 20 --------------------
.../{bug_report.md => problem_report.md} | 15 +++++++--------
.github/ISSUE_TEMPLATE/proposal.md | 14 +++++++-------
4 files changed, 36 insertions(+), 35 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md
new file mode 100644
index 0000000..c29ede8
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature.md
@@ -0,0 +1,22 @@
+---
+name: Feature/Change
+about: A template for Druid feature and change descriptions
+title: ""
+labels: Feature/Change Description
+assignees: ''
+
+---
+
+### Description
+
+Please describe the feature or change with as much detail as possible.
+
+If you have a detailed implementation in mind and wish to contribute that implementation yourself, and the change that
+you are planning would require a 'Design Review' tag because it introduces or changes some APIs, or it is large and
+imposes lasting consequences on the codebase, please open a Proposal instead.
+
+### Motivation
+
+Please provide the following for the desired feature or change:
+- A detailed description of the intended use case, if applicable
+- Rationale for why the desired feature/change would be beneficial
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index 9d279ca..0000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,20 +0,0 @@
----
-name: Feature/Change Request
-about: A template for Druid feature and change requests
-title: ""
-labels: Wish list
-assignees: ''
-
----
-
-# Description
-
-Please describe the feature or change with as much detail as possible.
-
-If you have a detailed implementation in mind and wish to contribute that implementation yourself, please open a Proposal issue instead.
-
-# Motivation
-
-Please provide the following for the desired feature or change:
-- A detailed description of the intended use case, if applicable
-- Rationale for why the desired feature/change would be beneficial
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/problem_report.md
similarity index 59%
rename from .github/ISSUE_TEMPLATE/bug_report.md
rename to .github/ISSUE_TEMPLATE/problem_report.md
index 91b0097..3ddb741 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/problem_report.md
@@ -1,23 +1,22 @@
---
-name: Bug Report
-about: A template for Druid bug reports
+name: Problem Report
+about: A template for Druid problem reports
title: ""
-labels: Bug
assignees: ''
---
Please provide a detailed title (e.g. "Broker crashes when using TopN query with Bound filter" instead of just "Broker crashes").
-# Affected Version
+### Affected Version
-The Druid version where the bug was encountered.
+The Druid version where the problem was encountered.
-# Description
+### Description
-Please include as much detailed information about the bug as possible.
+Please include as much detailed information about the problem as possible.
- Cluster size
- Configurations in use
-- Steps to reproduce the bug
+- Steps to reproduce the problem
- The error message or stack traces encountered. Providing more context, such as nearby log messages or even entire logs, can be helpful.
- Any debugging that you have already done
diff --git a/.github/ISSUE_TEMPLATE/proposal.md b/.github/ISSUE_TEMPLATE/proposal.md
index 3c04338..73baab6 100644
--- a/.github/ISSUE_TEMPLATE/proposal.md
+++ b/.github/ISSUE_TEMPLATE/proposal.md
@@ -2,16 +2,16 @@
name: Proposal
about: A template for major Druid change proposals
title: "[PROPOSAL]"
-labels: Proposal
+labels: Proposal, Design Review
assignees: ''
---
-# Motivation
+### Motivation
A description of the problem.
-# Proposed changes
+### Proposed changes
This section should provide a detailed description of the changes being proposed. This will usually be the longest section; please feel free to split this section or other sections into subsections if needed.
@@ -21,11 +21,11 @@ This section should include any changes made to user-facing interfaces, for exam
- SQL language
- Emitted metrics
-# Rationale
+### Rationale
A discussion of why this particular solution is the best one. One good way to approach this is to discuss other alternative solutions that you considered and decided against. This should also include a discussion of any specific benefits or drawbacks you are aware of.
-# Operational impact
+### Operational impact
This section should describe how the proposed changes will impact the operation of existing clusters. It should answer questions such as:
@@ -33,10 +33,10 @@ This section should describe how the proposed changes will impact the operation
- Is there a migration path that cluster operators need to be aware of?
- Will there be any effect on the ability to do a rolling upgrade, or to do a rolling _downgrade_ if an operator wants to switch back to a previous version?
-# Test plan (optional)
+### Test plan (optional)
An optional discussion of how the proposed changes will be tested. This section should focus on higher level system test strategy and not unit tests (as UTs will be implementation dependent).
-# Future work (optional)
+### Future work (optional)
An optional discussion of things that you believe are out of scope for the particular proposal but would be nice follow-ups. It helps show where a particular change could be leading us. There isn't any commitment that the proposal author will actually work on the items discussed in this section.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org