|
| 1 | +# How to Contribute |
| 2 | + |
| 3 | +Contributions are always welcome! Please use the following guidelines when contributing to `cargo-graph` |
| 4 | + |
| 5 | +1. Fork `cargo-graph` |
| 6 | +2. Clone your fork (`git clone https://github.com/$YOUR_USERNAME/cargo-graph && cd cargo-graph`) |
| 7 | +3. Create new branch (`git checkout -b new-branch`) |
| 8 | +4. Make your changes, and commit (`git commit -am "your message"`) |
| 9 | + * I use a [conventional](https://github.com/ajoslin/conventional-changelog/blob/a5505865ff3dd710cf757f50530e73ef0ca641da/conventions/angular.md) changelog format so I can update my changelog using [clog](https://github.com/clog-tool/clog-cli) |
| 10 | + * In addition to the conventions defined above, I also use `imp`, `wip`, `examples`. |
| 11 | + * Format your commit subject line using the following format: `TYPE(COMPONENT): MESSAGE` where `TYPE` is one of the following: |
| 12 | + - `feat` - A new feature |
| 13 | + - `imp` - An improvement to an existing feature |
| 14 | + - `perf` - A performance improvement |
| 15 | + - `docs` - Changes to documentation only |
| 16 | + - `tests` - Changes to the testing framework or tests only |
| 17 | + - `fix` - A bug fix |
| 18 | + - `refactor` - Code functionality doesn't change, but underlying structure may |
| 19 | + - `style` - Stylistic changes only, no functionality changes |
| 20 | + - `wip` - A work in progress commit (Should typically be `git rebase`'ed away) |
| 21 | + - `chore` - Catch all or things that have to do with the build system, etc |
| 22 | + - `examples` - Changes to existing example, or a new example |
| 23 | + * The `COMPONENT` is optional, and may be a single file, directory, or logical component. Can be omitted if commit applies globally |
| 24 | +5. Run the tests (`cargo test `) |
| 25 | +6. `git rebase` into concise commits and remove `--fixup`s (`git rebase -i HEAD~NUM` where `NUM` is number of commits back) |
| 26 | +7. Push your changes back to your fork (`git push origin $your-branch`) |
| 27 | +8. Create a pull request! (You can also create the pull request first, and we'll merge when ready. This a good way to discuss proposed changes.) |
| 28 | + |
0 commit comments