Skip to content

Commit

Permalink
Add boilerplate github files
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Smith <tsmith@chef.io>
  • Loading branch information
tas50 committed Oct 18, 2019
1 parent 336a260 commit 261097c
Show file tree
Hide file tree
Showing 7 changed files with 110 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Order is important. The last matching pattern has the most precedence.

* @chef/chef-foundation-owners @chef/chef-foundation-approvers @chef/chef-foundation-reviewers
.expeditor/ @chef/jex-team
*.md @chef/docs-team
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: � Bug Report
about: If something isn't working as expected �.
labels: "Status: Untriaged"
---

# Description

Briefly describe the issue

# ChefDK Version

Tell us which version of the ChefDK you are running. Run `chef --version` to display the version.

# Platform Version

Tell us which operating system distribution and version ChefDK 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.

# Stacktrace

Please include the stacktrace.out output or link to a gist of it, if there is one.

## NOTE: CHEFDK BUGS ONLY

This issue tracker is for the code contained within this repo -- `chefdk`.

- [Server issues](https://github.com/chef/chef-server/issues/new)
- [Chef-client issues](https://github.com/chef/chef/issues/new)
- Cookbook Issues (see the <https://github.com/chef-cookbooks> repos or search [Supermarket](https://supermarket.chef.io) or GitHub/Google)
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md
Original file line number Diff line number Diff line change
@@ -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? -->
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/ENHANCEMENT_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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. -->
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions .github/lock.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
daysUntilLock: 60
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Please refer to CONTRIBUTING.md for the `chef` project: https://github.com/chef/chef/blob/master/CONTRIBUTING.md".

For information about building and testing, see [BUILDING.md](BUILDING.md) in this repository.

0 comments on commit 261097c

Please sign in to comment.