flesh out CONTRIBUTING instructions

This commit is contained in:
Maxwell G 2023-09-04 20:07:05 +00:00
commit 6856173468
Signed by: gotmax23
GPG key ID: F79E4E25E8C661F8

View file

@ -23,6 +23,10 @@ todo.sr.ht, but it's only for confirmed issues.
[tracker]: https://todo.sr.ht/~gotmax23/forge-srpm-macros
## Testing
This repository uses `nox` to run unit tests and Python linters.
## Patches
Contributions are always welcome!
@ -40,17 +44,21 @@ After configuring git-send-email as explained at [git-send-email.io][1]:
[1]: https://git-send-email.io
```
# Clone the repo
git clone https://git.sr.ht/~gotmax23/forge-srpm-macros
cd forge-srpm-macros
# First time only
# Configure the repo. Only needs to be run once.
git config sendemail.to "~gotmax23/forge-srpm-macros@lists.sr.ht"
git config format.subjectprefix "PATCH forge-srpm-macros"
# Make your changes
$EDITOR ...
pytest
# Run tests using mock
nox
# Commit your changes and send your patch to the mailing list
git commit -a -v
git send-email origin/main
```