From 47eafef81ebf5badee055136717bdb43ac3c232e Mon Sep 17 00:00:00 2001
From: Tim Smith <tsmith@chef.io>
Date: Wed, 24 Apr 2019 20:14:30 -0700
Subject: [PATCH] Add github templates

Signed-off-by: Tim Smith <tsmith@chef.io>
---
 .github/CODEOWNERS                            | 10 +++--
 .github/ISSUE_TEMPLATE.md                     | 15 -------
 .github/ISSUE_TEMPLATE/BUG_TEMPLATE.md        | 29 ++++++++++++++
 .github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md     | 40 +++++++++++++++++++
 .../ENHANCEMENT_REQUEST_TEMPLATE.md           | 17 ++++++++
 .github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md    | 12 ++++++
 .github/PULL_REQUEST_TEMPLATE.md              |  2 +-
 .github/lock.yml                              |  1 +
 README.md                                     |  5 +--
 9 files changed, 109 insertions(+), 22 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE.md
 create mode 100644 .github/ISSUE_TEMPLATE/BUG_TEMPLATE.md
 create mode 100644 .github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md
 create mode 100644 .github/ISSUE_TEMPLATE/ENHANCEMENT_REQUEST_TEMPLATE.md
 create mode 100644 .github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md
 create mode 100644 .github/lock.yml

diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index 82684d5..8029e13 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -1,3 +1,7 @@
-*                 @chef/client-maintainers
-.expeditor/**     @chef/jex-team
-README.md         @chef/docs-team
+# Order is important. The last matching pattern has the most precedence.
+
+*                          @chef/client-maintainers
+.expeditor/**              @chef/jex-team
+README.md                  @chef/docs-team
+RELEASE_NOTES.md           @chef/docs-team
+.github/ISSUE_TEMPLATE/**  @chef/docs-team
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index ff9b717..0000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,15 +0,0 @@
-## Description
-
-Briefly describe the issue
-
-## Chef & Cheffish Version
-
-Tell us which version of Chef and Cheffish you are using.
-
-## Platform Version
-
-Tell us which Operating System distribution and version Chef is running on.
-
-## Replication Case
-<!--- Tell us what steps to take to replicate your problem.  See [How to create a Minimal, Complete, and Verifiable example](https://stackoverflow.com/help/mcve)
-for information on how to create a good replication case. -->
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md b/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md
new file mode 100644
index 0000000..f28915b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md
@@ -0,0 +1,29 @@
+---
+name: � Bug Report
+about: If something isn't working as expected �.
+labels: "Status: Untriaged"
+---
+
+# Version:
+
+[Version of the project installed]
+
+# Environment:
+
+[Details about the environment such as the Operating System, cookbook details, etc...]
+
+# Scenario:
+
+[What you are trying to achieve and you can't?]
+
+# Steps to Reproduce:
+
+[If you are filing an issue what are the things we need to do in order to repro your problem?]
+
+# Expected Result:
+
+[What are you expecting to happen as the consequence of above reproduction steps?]
+
+# Actual Result:
+
+[What actually happens after the reproduction steps?]
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?  -->
diff --git a/.github/ISSUE_TEMPLATE/ENHANCEMENT_REQUEST_TEMPLATE.md b/.github/ISSUE_TEMPLATE/ENHANCEMENT_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..65bf5a0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/ENHANCEMENT_REQUEST_TEMPLATE.md
@@ -0,0 +1,17 @@
+---
+name: 🚀 Enhancement Request
+about: I have a suggestion (and may want to implement it 🙂)!
+labels: "Status: Untriaged"
+---
+
+### Describe the Enhancement:
+<!---  What you are trying to achieve that you can't? -->
+
+### Describe the Need:
+<!---  What kind of user do you believe would utilize this enhancement, and how many users might want this functionality -->
+
+### Current Alternative
+<!--- Is there a current alternative that you can utilize to workaround the lack of this enhancement -->
+
+### Can We Help You Implement This?:
+<!---  The best way to ensure your enhancement is built is to help implement the enhancement yourself. If you're interested in helping out we'd love to give you a hand to make this possible. Let us know if there's something you need. -->
diff --git a/.github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md b/.github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md
new file mode 100644
index 0000000..68c5664
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md
@@ -0,0 +1,12 @@
+---
+name: 🤗 Support Question
+about: If you have a question 💬, please check out our Slack!
+---
+
+We use GitHub issues to track bugs and feature requests. If you need help please post to our Mailing List or join the Chef Community Slack.
+
+ * Chef Community Slack at http://community-slack.chef.io/.
+ * Chef Mailing List https://discourse.chef.io/
+
+
+ Support issues opened here will be closed and redirected to Slack or Discourse.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index dc554f3..0df03f8 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -11,5 +11,5 @@ StackOverflow discussions that are relevant]
 
 - [ ] New functionality includes tests
 - [ ] All tests pass
-- [ ] RELEASE\_NOTES.md, has been updated if required (not required for bugfixes, required for API changes)
 - [ ] All commits have been signed-off for the Developer Certificate of Origin. See <https://github.com/chef/chef/blob/master/CONTRIBUTING.md#developer-certification-of-origin-dco>
+- [ ] PR title is a worthy inclusion in the CHANGELOG
\ No newline at end of file
diff --git a/.github/lock.yml b/.github/lock.yml
new file mode 100644
index 0000000..66d5d49
--- /dev/null
+++ b/.github/lock.yml
@@ -0,0 +1 @@
+daysUntilLock: 60
diff --git a/README.md b/README.md
index 883e3c3..bc2b51a 100644
--- a/README.md
+++ b/README.md
@@ -26,14 +26,13 @@ You'd use these in recipes/cookbooks. They are documented on the [main Chef docs
 - [chef_resolved_cookbooks](https://docs.chef.io/resource_chef_resolved_cookbooks.html)
 - [chef_role](https://docs.chef.io/resource_chef_role.html)
 - [chef_user](https://docs.chef.io/resource_chef_user.html)
-- [private_key](https://docs.chef.io/resource_private_key.html)
-- [public_key](https://docs.chef.io/resource_public_key.html)
+- [private_key](https://docs.chef.io/resource_private_key.html) - DEPRECATED
+- [public_key](https://docs.chef.io/resource_public_key.html) - DEPRECATED
 
 ## Base/Helper Classes
 
 To support the resource/provider pairs.
 
-
 ## RSpec Support
 
 Most of these RSpec...things were developed for testing the resource/provider pairs above; *however*, you can also `require cheffish/rspec/chef_run_support` for any RSpec `expect`s you'd like, as we do for `chef-provisioning` and its drivers (especially `chef-provisioning-aws`).