diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..469c4787 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,54 @@ + + +### Description of the Change + + + +### Alternate Designs + + + +### Benefits + + + +### Possible Drawbacks + + + +### Verification Process + + + +### Checklist: + + + +- [ ] I have read the [**CONTRIBUTING**](https://github.com/10up/Engineering-Best-Practices/CONTRIBUTING.md) document. +- [ ] My code follows the code style of this project. +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly. + + + +### Applicable Issues + + + +### Changelog Entry + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..279a7197 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# Contributing and Maintaining + +First, thank you for taking the time to contribute! + +The following is a set of guidelines for contributors as well as information and instructions around our maintenance process. The two are closely tied together in terms of how we all work together and set expectations, so while you may not need to know everything in here to submit an issue or pull request, it's best to keep them in the same document. + +## Ways to contribute + +Contributing isn't just writing code - it's anything that improves the project. All contributions are managed right here on GitHub. Here are some ways you can help: + +### Reporting bugs + +If you're running into an issue, please take a look through [existing issues](https://github.com/10up/Engineering-Best-Practices/issues) and [open a new one](https://github.com/10up/Engineering-Best-Practices/issues/new) if needed. If you're able, include steps to reproduce, environment information, and screenshots/screencasts as relevant. + +### Suggesting enhancements + +New features and enhancements are also managed via [issues](https://github.com/10up/Engineering-Best-Practices/issues). + +### Pull requests + +Pull requests represent a proposed solution to a specified problem. They should always reference an issue that describes the problem and contains discussion about the problem itself. Discussion on pull requests should be limited to the pull request itself, i.e. code review. + +For more on how 10up writes and manages code, check out our [10up Engineering Best Practices](https://10up.github.io/Engineering-Best-Practices/). + +## Workflow + +Always work on the `gh-pages` branch and open up PRs against `gh-pages`. diff --git a/_includes/markdown/Introduction.md b/_includes/markdown/Introduction.md index 7bf14924..cbf0fdb8 100644 --- a/_includes/markdown/Introduction.md +++ b/_includes/markdown/Introduction.md @@ -26,4 +26,4 @@ We are constantly challenging ourselves and learning. Knowledge gives us a compe

Contributing {% include Util/link_anchor anchor="contributing" %} {% include Util/top %}

-Please contribute via [pull requests on GitHub](https://github.com/10up/Engineering-Best-Practices). +Details on contributing to our Engineering Best Practices is described in [CONTRIBUTING.md](https://github.com/10up/Engineering-Best-Practices/blob/gh-pages/CONTRIBUTING.md). Please contribute via [pull requests on GitHub](https://github.com/10up/Engineering-Best-Practices).