summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2019-04-03 12:00:34 -0700
committerTim Smith <tsmith@chef.io>2019-04-03 12:00:34 -0700
commitf8f882c8c53bc8d6dab4a6032b09ef558fa12ee2 (patch)
tree17e5f11438c683a49bfc6c0aa14781ace6b2d3f3
parent05e507952d8dbff8e31528f1ebcab72664e99aa2 (diff)
downloadohai-f8f882c8c53bc8d6dab4a6032b09ef558fa12ee2.tar.gz
Add design proposal issue template
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md39
-rw-r--r--.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md (renamed from .github/ISSUE_TEMPLATE.md)0
-rw-r--r--.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md (renamed from .github/PULL_REQUEST_TEMPLATE.md)0
3 files changed, 39 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md b/.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md
new file mode 100644
index 00000000..ff55a658
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md
@@ -0,0 +1,39 @@
+---
+name: 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? -->
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md
index c1d43ea5..c1d43ea5 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md
index dc554f31..dc554f31 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md