Skip to content

Commit

Permalink
Add a CONTRIBUTING guide
Browse files Browse the repository at this point in the history
  • Loading branch information
tgautier committed Jun 19, 2017
1 parent ab19de1 commit ad4683b
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 12 deletions.
21 changes: 21 additions & 0 deletions 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
```
13 changes: 1 addition & 12 deletions README.md
Expand Up @@ -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

Expand Down

0 comments on commit ad4683b

Please sign in to comment.