Skip to content

Commit

Permalink
Contributing information
Browse files Browse the repository at this point in the history
adds a CONTRIBUTING.md file and a PR template
  • Loading branch information
ChapelR committed Apr 11, 2021
1 parent 7998798 commit 6760e4c
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
**Issue:**

Fixes # . (Please reference the related issue here. If there is no related issue, please open one. If the PR does not close the referenced issue, please remove "Fixes.")

**Description:**

Please briefly describe the changes this PR makes.

**Credit:**

If you are not already credited in the cookbook, you can describe how you wish to be credited. You may provide a name or username and a website to link to.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Contributions

The cookbook welcomes and encourages contributions from anyone. These can be suggestions, new recipes, updates, or corrections. Please follow the process outlined below when making a contribution.

### 1. Open an Issue

Before doing anything else, please open an issue detailing the proposed changes. This is to prevent multiple people from working independently on the same changes, and also allows for comments and feedback on proposed changes before any significant work is done.

### 2. Create a Pull Request

**Note:** Please use the pull request template!

All pull requests should refer to an issue, and only one issue. Please note in your pull request how you would like to be credited in the cookbook, providing a name or handle and (optionally) a link to a website. If not otherwise provided, the GitHub username and profile page for the person opening the PR will be credited.

### 3. Approval or Rejection of Changes

Pull requests must receive approval at least two of the cookbook's editors. Once a PR has been approved, it can be merged by any editor. Likewise, if a PR is rejected by at least two editors, it can be closed.

0 comments on commit 6760e4c

Please sign in to comment.