From 2ecb4c66de652d7e07f2755d44167b09c2a7c322 Mon Sep 17 00:00:00 2001 From: devins2518 Date: Thu, 8 Apr 2021 09:28:56 -0500 Subject: [PATCH] docs: added CONTRIBUTING.md and a pull request template (#32) * docs: add CONTRIBUTING.md * docs: add pull request template --- .github/pull_request_template.md | 5 +++++ CONTRIBUTING.md | 10 ++++++++++ 2 files changed, 15 insertions(+) create mode 100644 .github/pull_request_template.md create mode 100644 CONTRIBUTING.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..4841aec --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,5 @@ +--- +- [ ] I have reviewed CONTRIBUTING.md. +- [ ] My commits and title use the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) format. +- [ ] I have documented any breaking changes according to [SemVer](https://semver.org/). +--- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bd26ca1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +# Contributing + +## Pull Request Process + +1. Ensure that any new install or build dependencies are documented in the README.md and PR request. +2. Update the README.md with details of changes to the shell, this includes useful file locations + and breaking changes. +3. The versioning scheme we use is [SemVer](http://semver.org/) and the commit scheme we use is + [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Please document any + backwards incompatible changes and be sure to name your commits correctly.