Create CONTRIBUTING.md

This commit is contained in:
Patrick Auernig 2018-03-23 10:44:52 +01:00
parent 53bab6857e
commit 6d83bc0af2
2 changed files with 17 additions and 0 deletions

13
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,13 @@
# Contributing Guidelines
Contributions to this project are welcome, just follow there steps.
1. Fork this repository and create a feature branch named after the feature you want to implement
2. Make your changes on your branch
3. Add some test if possibe
4. Make sure all tests pass (I recommend installing [Overcommit][overcommit])
5. Submit a PR/MR on GitHub or GitLab
> **Note**: Make sure you rebase your feature branch on top of master from time to time.
[overcommit]: https://github.com/brigade/overcommit

View File

@ -19,6 +19,10 @@ discord-rpc-client = "^0.1"
Examples can be found in the examples directory in this repo.
## Contributions
See [CONTRIBUTING.md](CONTRIBUTING.md)
[gitlab-ci-badge]: https://gitlab.com/valeth/discord-rpc-client.rs/badges/master/pipeline.svg
[gitlab-repo-master]: https://gitlab.com/valeth/discord-rpc-client.rs/commits/master
[crates-io-badge]: https://img.shields.io/crates/v/discord-rpc-client.svg