Skip to content

Commit

Permalink
docs: add Karma commit messages to CONTRIBUTING.md (topgrade-rs#493)
Browse files Browse the repository at this point in the history
Add Karma commit messages to CONTRIBUTING.md
  • Loading branch information
xeruf authored Jul 14, 2023
1 parent 2068c2c commit 8350475
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
## Contributing to `topgrade`

Thank you for your interest in contributing to `topgrade`! We welcome and encourage
contributions of all kinds, such as:
Thank you for your interest in contributing to `topgrade`!
We welcome and encourage contributions of all kinds, such as:

1. Issue reports or feature requests
2. Documentation improvements
3. Code (PR or PR Review)

Please follow the [Karma Runner guidelines](http://karma-runner.github.io/6.2/dev/git-commit-msg.html)
for commit messages.

## Adding a new `step`

In `topgrade`'s term, package manager is called `step`. To add a new `step` to
`topgrade`:
In `topgrade`'s term, package manager is called `step`.
To add a new `step` to `topgrade`:

1. Add a new variant to
[`enum Step`](https://github.com/topgrade-rs/topgrade/blob/cb7adc8ced8a77addf2cb051d18bba9f202ab866/src/config.rs#L100)
Expand Down

0 comments on commit 8350475

Please sign in to comment.