From ad4683bfa73131b698e78ede22b29afc7ffab06d Mon Sep 17 00:00:00 2001 From: Thomas Gautier Date: Sun, 18 Jun 2017 19:40:09 +0200 Subject: [PATCH] Add a CONTRIBUTING guide --- CONTRIBUTING.md | 21 +++++++++++++++++++++ README.md | 13 +------------ 2 files changed, 22 insertions(+), 12 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..59f0851 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing + +We welcome Pull Requests from anyone 👐 + +By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md). + +Before submitting a Pull Request, please ensure the following: + +1. Your code is covered by tests +2. Make sure all tests are passing +3. Only have one commit with a relevant message (you can rebase and squash all your commits into a single one) +4. Check that you're up to date by rebasing your branch with our `develop` branch + +## Setup + +``` +$ git clone https://github.com/fewlinesco/bamboo_smtp.git +$ cd bamboo_smtp +$ mix deps.get +$ mix test +``` diff --git a/README.md b/README.md index 831b158..e3c6b56 100644 --- a/README.md +++ b/README.md @@ -52,18 +52,7 @@ You can find more information about advanced features in the [Wiki](https://gith ## Contributing -Before opening a pull request you can open an issue if you have any question or need some guidance. - -Here's how to setup the project: - -``` -$ git clone https://github.com/fewlinesco/bamboo_smtp.git -$ cd bamboo_smtp -$ mix deps.get -$ mix test -``` - -Once you've made your additions and `mix test` passes, go ahead and open a Pull Request. +You can see the specific [CONTRIBUTING](CONTRIBUTING.md) guide. ## License