summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2019-03-26 12:35:40 -0700
committerTim Smith <tsmith@chef.io>2019-03-26 12:35:40 -0700
commit674fe2116e1d507bb6b87764dc62f4b1e2126858 (patch)
tree7514dc4f26aa8907d53372df275707cd09ab20df /.github
parent6837d6bda9fbfdcab0c2d26f3313ec106137e203 (diff)
downloadchef-674fe2116e1d507bb6b87764dc62f4b1e2126858.tar.gz
Add Design Propsal issue template
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md b/.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md
new file mode 100644
index 0000000000..2925c0d0d1
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md
@@ -0,0 +1,40 @@
+---
+name: :pencil2: Design Proposal
+about: I have a significant change I would like to propose and discuss before starting
+
+---
+
+### When a Change Needs a Design Proposal
+
+A design proposal should be opened any time a change meets one of the following qualifications:
+
+- Significantly changes the user experience of a project in a way that impacts users.
+- Significantly changes the underlying architecture of the project in a way that impacts other developers.
+- Changes the development or testing process of the project such as a change of CI systems or test frameworks.
+
+### Why We Use This Process
+
+- Allows all interested parties (including any community member) to discuss large impact changes to a project.
+- Serves as a durable paper trail for discussions regarding project architecture.
+- Forces design discussions to occur before PRs are created.
+- Reduces PR refactoring and rejected PRs.
+
+---
+
+<!--- Proposal description and rationale. -->
+
+## Motivation
+
+<!---
+ As a <<user_profile>>,
+ I want to <<functionality>>,
+ so that <<benefit>>.
+ -->
+
+## Specification
+
+<!--- A detailed description of the planned implementation. -->
+
+## Downstream Impact
+
+<!--- Which other tools will be impacted by this work? -->