From 6d83bc0af265a6fee78185908db6ebb9a8aaf627 Mon Sep 17 00:00:00 2001 From: Patrick Auernig Date: Fri, 23 Mar 2018 10:44:52 +0100 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 13 +++++++++++++ README.md | 4 ++++ 2 files changed, 17 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..81a787d --- /dev/null +++ b/CONTRIBUTING.md @@ -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 diff --git a/README.md b/README.md index 3835b49..a740382 100644 --- a/README.md +++ b/README.md @@ -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