docs/contributing.md
# Contributing
First of all thanks for your time and your interest!
When contributing to this repository, please first discuss the change you wish to make via [issue](https://github.com/amenezes/rabbit-client/issues), [email](mailto:alexandre.fmenezes@gmail.com), or any other method with the owners of this repository before making a change.
## Guideline
### General
To ensure minimal consisteny follow code standards or propose a better approach by discussing any of the methods listed in the previous topic.
If you have any questions related to the project first try to check the [documentation](https://rabbit-client.amenezes.net) if that is not enough open a issue and try describe:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can
- What you expected happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
### Code
Steps to a good pull request:
- Discuss the PR before
- Write tests (preferably cover success and fail path)
- If relevant write documentation providing:
- an overview about the feature
- a code snippet
### License
Any contributions you make will be under the project license.