From 4f5095e52cd85f8fab9dca378cbe3152e74dc828 Mon Sep 17 00:00:00 2001 From: Evan Sangaline Date: Fri, 15 Jun 2018 08:01:42 -0400 Subject: [PATCH] Create a separate `CONTRIBUTING.md` file. --- CONTRIBUTING.md | 8 ++++++++ README.md | 3 +-- 2 files changed, 9 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b2496d8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +## Contributing + +Contributions are welcome, but please follow these contributor guidelines: + +- Create an issue on [the issue tracker](https://github.com/intoli/exodus/issues/new) to discuss potential changes before submitting a pull request. +- Include at least one test to cover any new functionality or bug fixes. +- Make sure that all of your tests are passing and that there are no merge conflicts. +- You agree to sign the project's [Contributor License Agreement](https://www.clahub.com/agreements/intoli/exodus). diff --git a/README.md b/README.md index dc03ef5..a2232de 100644 --- a/README.md +++ b/README.md @@ -519,8 +519,7 @@ tox ## Contributing -Contributions are welcome, but please create an issue on [the issue tracker](https://github.com/intoli/exodus/issues/new) first to discuss the contribution first. -New feature additions should include tests and it's a requirement that all tests must pass before pull requests are merged. +Contributions are welcome, but please follow these contributor guideline that are outlined in [CONTRIBUTING.md](CONTRIBUTING.md). ## License