From 86b622a8126fe98f4739c30f2a521db2e7e628d6 Mon Sep 17 00:00:00 2001 From: Francisco Hodge Date: Thu, 21 Jan 2021 18:20:56 -0500 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c6e87869 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before working on a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Guidelines + +1. Please ensure your proposal will not radically change current functionality or bring along breaking changes. +2. PRs only consisting of typo fixes (or other automated contributions), will not be accepted. +3. Do not add any dependencies to the project. +4. Document your changes thoroughly. +5. Ensure coverage is complete (`npm run coverage` should show 100% coverage) and that none of the tests fail. +6. Be reactive to any comments, reviews or change requests entered in your pull request.