/ CONTRIBUTING.md
CONTRIBUTING.md
 1  Contributions are welcome. Contributions come in many forms. You could:
 2  
 3    1. Submit a feature request or bug report as an [issue].
 4    2. Ask for improved documentation as an [issue].
 5    3. Comment on [issues that require feedback].
 6    4. Contribute code via [pull requests].
 7  
 8  [issue]: https://github.com/thelastinuit/bouncer/issues
 9  [issues that require feedback]: https://github.com/thelastinuit/bouncer/issues?q=is%3Aissue+is%3Aopen+label%3A%22feedback+wanted%22
10  [pull requests]: https://github.com/thelastinuit/bouncer/pulls
11  
12  Any code you contribute must be:
13  
14    * **Commented:** Public items _must_ be commented.
15    * **Documented:** Exposed items _must_ have rustdoc comments with
16      examples, if applicable.
17    * **Styled:** Your code should be `rustfmt`'d when possible.
18    * **Simple:** Your code should accomplish its task as simply and
19       idiomatically as possible.
20    * **Tested:** You must add (and pass) convincing tests for any functionality you add.
21    * **Focused:** Your code should do what it's supposed to do and nothing more.
22  
23  All pull requests are code reviewed and tested by the CI. Note that unless you
24  explicitly state otherwise, any contribution intentionally submitted for
25  inclusion by you shall be under the MIT License without any additional terms or conditions.