Adjust issue templates (#7188)

* Adjust issue templates

* typo

* bug -> problem
This commit is contained in:
Roman Leventov 2019-03-05 21:06:40 -03:00 committed by Jonathan Wei
parent 65118277a3
commit 37cbad79b1
4 changed files with 36 additions and 35 deletions

22
.github/ISSUE_TEMPLATE/feature.md vendored Normal file
View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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.