summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2019-04-23 11:57:44 -0700
committerTim Smith <tsmith@chef.io>2019-04-23 11:57:44 -0700
commit81ea20bbb6e4da0a0f143b6d4160a391b89fb3fd (patch)
tree72f18c2952fd6c445636aa18907e8f5c2628619e /.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md
parente78381fd5c2a9d723b63a24ca97aa21dafe18f8f (diff)
downloadmixlib-authentication-81ea20bbb6e4da0a0f143b6d4160a391b89fb3fd.tar.gz
Add back Ruby 2.4 support / update testing
Add back Ruby 2.4 support Test on more versions in Appveyor Test on the latest ruby versions in Travis Add our full set of GitHub templates Enable issue locking Add a contributing file Signed-off-by: Tim Smith <tsmith@chef.io>
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..9f4a958
--- /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"
+---
+
+### 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? -->