summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2019-12-29 18:10:35 -0800
committerGitHub <noreply@github.com>2019-12-29 18:10:35 -0800
commitb39025e9526e65bc88c0c1ed2c2e1341340fcb13 (patch)
tree39213a71e48aaa14aa43931b829fd08741d30eb1 /.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md
parent7c856ba33f5bda1eb636843e3968214cc140141a (diff)
parent30dc4f1b2b7f93c866b29d54e8b701031f1fa824 (diff)
downloadchef-zero-b39025e9526e65bc88c0c1ed2c2e1341340fcb13.tar.gz
Merge pull request #296 from chef/relative
Substitute require for require_relative
Diffstat (limited to '.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md')
-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 0000000..9508b09
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md
@@ -0,0 +1,40 @@
+---
+name: Design Proposal
+about: I have a significant change I would like to propose and discuss before starting
+labels: "Status: Untriaged, Type: Design Proposal"
+---
+
+### 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? -->