From 9e65dd4bb0d61be1c6862599099df1fbbdf3083c Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Fri, 5 Apr 2019 21:28:01 -0700 Subject: Add Github templates Signed-off-by: Tim Smith --- .expeditor/config.yml | 1 + .github/CODEOWNERS | 7 ++++ .github/ISSUE_TEMPLATE/BUG_TEMPLATE.md | 29 ++++++++++++++++ .github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md | 40 ++++++++++++++++++++++ .../ISSUE_TEMPLATE/ENHANCEMENT_REQUEST_TEMPLATE.md | 17 +++++++++ .github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md | 12 +++++++ .github/PULL_REQUEST_TEMPLATE.md | 15 ++++++++ .github/lock.yml | 1 + CONTRIBUTING.md | 1 + 9 files changed, 123 insertions(+) create mode 100644 .github/CODEOWNERS 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/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/lock.yml create mode 100644 CONTRIBUTING.md diff --git a/.expeditor/config.yml b/.expeditor/config.yml index 94d1e13..a7b2790 100644 --- a/.expeditor/config.yml +++ b/.expeditor/config.yml @@ -16,6 +16,7 @@ github: # allow bumping the minor release via label minor_bump_labels: - "Expeditor: Bump Version Minor" + # allow bumping the major release via label major_bump_labels: - "Expeditor: Bump Version Major" diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..8029e13 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,7 @@ +# 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/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. + +--- + + + +## Motivation + + + +## Specification + + + +## Downstream Impact + + 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: + + +### Describe the Need: + + +### Current Alternative + + +### Can We Help You Implement This?: + 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 new file mode 100644 index 0000000..0df03f8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +### Description + +[Please describe what this change achieves] + +### Issues Resolved + +[List any existing issues this PR resolves, or any Discourse or +StackOverflow discussions that are relevant] + +### Check List + +- [ ] New functionality includes tests +- [ ] All tests pass +- [ ] All commits have been signed-off for the Developer Certificate of Origin. See +- [ ] 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/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..03fdbfa --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +Please refer to https://github.com/chef/chef/blob/master/CONTRIBUTING.md -- cgit v1.2.1