From e1715ad00241b3512413fc617dbe598946404226 Mon Sep 17 00:00:00 2001 From: Mira Okafor Date: Wed, 17 Jun 2026 18:25:00 -0500 Subject: [PATCH] docs: add a contributing guide --- README.md | 5 +++++ docs/contributing.md | 22 ++++++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 docs/contributing.md diff --git a/README.md b/README.md index 94a5a43f34686ffce19b9016e179cd56339a89bd..bc46ffcd52f7ce861ff67d7a2eb09853c2896292 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 0000000000000000000000000000000000000000..3e337ee3e1e94d202e650c80ac7296f32f1d4b1e --- /dev/null +++ b/docs/contributing.md @@ -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)