~reviewer/hello-hut

e1715ad00241b3512413fc617dbe598946404226 — Mira Okafor 4 months ago 9625423
docs: add a contributing guide
2 files changed, 27 insertions(+), 0 deletions(-)

M README.md
A docs/contributing.md
M README.md => README.md +5 -0
@@ 38,6 38,11 @@ shout = false

Every key is described in [docs/configuration.md](docs/configuration.md).

## Contributing

Patches are welcome by email.
Please read [docs/contributing.md](docs/contributing.md) first.

## License

MIT — see [LICENSE](LICENSE).

A docs/contributing.md => docs/contributing.md +22 -0
@@ 0,0 1,22 @@
# Contributing to hello-hut

Thanks for helping out! hello-hut uses an email-based workflow.

1. Clone the repository and make your change on a branch.
2. Add a test if you are fixing a bug.
3. Run `make test` and `make lint`.
4. Send your patches to the development list:

   ```sh
   git config sendemail.to "~reviewer/hello-hut-devel@lists.hut.md"
   git config format.subjectPrefix "PATCH hello-hut"
   git send-email origin/main
   ```

## Commit messages

- Prefix the subject with the area you touched, e.g. `cli:`, `docs:` or
  `tests:`.
- Keep the subject under 72 characters and explain *why* in the body.

See also: [installation](install.md) · [configuration](configuration.md)