diff options
author | Tim Smith <tsmith@chef.io> | 2019-04-23 11:22:32 -0700 |
---|---|---|
committer | Tim Smith <tsmith@chef.io> | 2019-04-23 11:22:32 -0700 |
commit | aff3fd3e33f899ea1cc4ab09e9a7126832b26c5f (patch) | |
tree | 0a7044bed32ef82709e6faa19cd63cbb4a63f53c | |
parent | 3119826cfb54a301d5c40bedb50de7418e404a8b (diff) | |
download | mixlib-cli-aff3fd3e33f899ea1cc4ab09e9a7126832b26c5f.tar.gz |
Add additional github templates and update codeownersboilerplate
Get this repo in line with our current standards.
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r-- | .expeditor/config.yml | 3 | ||||
-rw-r--r-- | .github/CODEOWNERS | 5 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/BUG_TEMPLATE.md (renamed from .github/ISSUE_TEMPLATE.md) | 10 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md | 40 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/ENHANCEMENT_REQUEST_TEMPLATE.md | 17 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md | 11 | ||||
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 3 | ||||
-rw-r--r-- | .github/lock.yml | 1 | ||||
-rw-r--r-- | .travis.yml | 3 | ||||
-rw-r--r-- | CONTRIBUTING.md | 1 |
10 files changed, 88 insertions, 6 deletions
diff --git a/.expeditor/config.yml b/.expeditor/config.yml index 53aa307..33c9d8a 100644 --- a/.expeditor/config.yml +++ b/.expeditor/config.yml @@ -16,7 +16,8 @@ github: # allow bumping the minor release via label minor_bump_labels: - "Expeditor: Bump Version Minor" - mmajor_bump_labels: + # allow bumping the major release via label + major_bump_labels: - "Expeditor: Bump Version Major" changelog: diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index fee8d42..9dbcc7b 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,4 +1,5 @@ # Order is important. The last matching pattern has the most precedence. -* @chef/client-maintainers -.expeditor/** @chef/jex-team +* @chef/chef-infra-reviewers +.expeditor/** @chef/jex-team +*.md @chef/docs-team diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md index f229e13..f28915b 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md @@ -1,8 +1,16 @@ +--- +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...] +# Environment: + +[Details about the environment such as the Operating System, cookbook details, etc...] # Scenario: 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..921a5f0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md @@ -0,0 +1,11 @@ +--- +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 441965f..0df03f8 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,10 +5,11 @@ ### Issues Resolved [List any existing issues this PR resolves, or any Discourse or -StackOverflow discussion that's relevant] +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 <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/.travis.yml b/.travis.yml index 50bdf41..8fb6452 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,10 +3,11 @@ cache: bundler dist: xenial before_install: - - gem install bundler + - gem install bundler || true - bundle --version - gem update --system - gem --version + matrix: include: - rvm: 2.4.5 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 |