|
| 1 | +# Contributing to semverver |
| 2 | + |
| 3 | +Want to help developing semverver? Cool! See below on how to do that. |
| 4 | + |
| 5 | +## Bug reports |
| 6 | + |
| 7 | +If you encounter any unwanted behaviour from the tool, such as crashes or other unexpected |
| 8 | +output, or if you think you have found a bug, please open an issue in GitHub's issue |
| 9 | +tracker. |
| 10 | + |
| 11 | +Please describe the steps to reproduce your problem, as well as what you expected to |
| 12 | +happen, and what happened instead. It is also useful to include the output of your command |
| 13 | +invocation(s) with the following environment: `RUST_LOG=debug RUST_BACKTRACE=full`. |
| 14 | +Please paste it at https://gist.github.com if the output is longer than a 50 lines or so. |
| 15 | + |
| 16 | +## Feature requests |
| 17 | + |
| 18 | +If you want to see some functionality added to semverver, you can also open an issue. Make |
| 19 | +sure to include what functionality you need exactly, why it is useful, and, depending on |
| 20 | +the complexity and/or how related the functionality is to the core project goals, why you |
| 21 | +think it should be implemented in semverver and not somewhere else. |
| 22 | + |
| 23 | +## Working on issues |
| 24 | + |
| 25 | +If you want to write code to make semverver better, please post in the issue(s) you want |
| 26 | +to tackle, and if you already have an idea/proposed solution, you are welcome to summarize |
| 27 | +it in case some discussion is necessary. |
| 28 | + |
| 29 | +Here are some guidelines you should try to stick to: |
| 30 | + |
| 31 | +* Please fork the repository on GitHub and create a feature branch in your fork. |
| 32 | +* Try to keep your code stylistically similar to the already existing codebase. |
| 33 | +* Commit your changes in compact, logically coupled chunks. |
| 34 | +* Make sure `cargo test` passes after your changes. |
| 35 | +* Run `rustfmt` on your code (for example by running `cargo fmt`). |
| 36 | +* If possible, fix any issues `cargo clippy` might find in your code. |
| 37 | +* Finally, make a pull request against the master branch on GitHub and wait for the CI to |
| 38 | + find any outstanding issues. |
0 commit comments