[incubator-druid] branch proposal-template updated: Add proposal template

[jo...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jonwei pushed a commit to branch proposal-template
in repository https://gitbox.apache.org/repos/asf/incubator-druid.git


The following commit(s) were added to refs/heads/proposal-template by this push:
     new 70ffac7  Add proposal template
70ffac7 is described below

commit 70ffac7fade8ba2fae7454b2a65aca3f684cfd4e
Author: Jonathan Wei <jo...@users.noreply.github.com>
AuthorDate: Tue Feb 12 16:08:43 2019 -0800

    Add proposal template
    
    Adds a proposal template based on the discussion in https://lists.apache.org/thread.html/bb9c5e1f8ce9b3148a5c26f95059f9b6629fae3bf8c617121d671395@%3Cdev.druid.apache.org%3E
---
 .github/ISSUE_TEMPLATE/proposal.md | 42 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/.github/ISSUE_TEMPLATE/proposal.md b/.github/ISSUE_TEMPLATE/proposal.md
new file mode 100644
index 0000000..7604776
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/proposal.md
@@ -0,0 +1,42 @@
+---
+name: Proposal
+about: A template for major Druid change proposals
+title: "[PROPOSAL]"
+labels: Proposal
+assignees: ''
+
+---
+
+# Motivation
+
+A description of the problem.
+
+# 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.
+
+This section should include any changes made to user-facing interfaces, for example:
+- Parameters
+- JSON query/ingest specs
+- SQL language
+- Emitted metrics
+
+# 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
+
+This section should describe how the proposed changes will impact the operation of existing clusters. It should answer questions such as:
+
+- Is anything going to be deprecated or removed by this change? How will we phase out old behavior?
+- 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)
+
+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)
+
+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