admin/topgrade
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add Karma commit messages to CONTRIBUTING.md (#493)

Browse Source 
Add Karma commit messages to CONTRIBUTING.md
This commit is contained in:
Janek
2023-07-14 18:11:59 +02:00
committed by GitHub
parent 2068c2c169
commit 83504754ac
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@@ -1,16 +1,19 @@
## Contributing to `topgrade` ## Contributing to `topgrade`
Thank you for your interest in contributing to `topgrade`! We welcome and encourage Thank you for your interest in contributing to `topgrade`!
contributions of all kinds, such as: We welcome and encourage contributions of all kinds, such as:
1. Issue reports or feature requests 1. Issue reports or feature requests
2. Documentation improvements 2. Documentation improvements
3. Code (PR or PR Review) 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` ## Adding a new `step`
In `topgrade`'s term, package manager is called `step`. To add a new `step` to In `topgrade`'s term, package manager is called `step`.
`topgrade`: To add a new `step` to `topgrade`:
1. Add a new variant to 1. Add a new variant to
[`enum Step`](https://github.com/topgrade-rs/topgrade/blob/cb7adc8ced8a77addf2cb051d18bba9f202ab866/src/config.rs#L100) [`enum Step`](https://github.com/topgrade-rs/topgrade/blob/cb7adc8ced8a77addf2cb051d18bba9f202ab866/src/config.rs#L100)