From b5be5c01ee0c38d55b31f07ad4e4b627072c9c04 Mon Sep 17 00:00:00 2001 From: Hampus Date: Wed, 29 Sep 2021 19:02:30 +0200 Subject: docs: add mailing list info --- README.md | 2 ++ docs_src/hacking.md | 10 ++++++++++ 2 files changed, 12 insertions(+) diff --git a/README.md b/README.md index b50e218..3f31e5d 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,8 @@ Any contribution or support is very welcome. ## Hacking You can find information about development in [the documentation](/docs_src/hacking.md) +Join the [mailing list](https://lists.hampusmat.com/mailman3/lists/githermit.lists.hampusmat.com/) for discussions, news & submitting patches. + ## Donating Monero: `49nv1PMFiamBhiiNkzP66H7zmogDEWsDaaUxDdQN2Ne5g7mErYy1upRRgPeVwPYB1r9YArktDiJSFdKUnRF1zf5fECoJRss` diff --git a/docs_src/hacking.md b/docs_src/hacking.md index 518477b..8d6c1b8 100644 --- a/docs_src/hacking.md +++ b/docs_src/hacking.md @@ -26,3 +26,13 @@ You may want to add the following to your settings.json You can use the following command to run a live-updating instance of Githermit. `$ yarn dev` + +## Submitting patches +Contributing your code should be done through the [mailing list](https://lists.hampusmat.com/mailman3/lists/githermit.lists.hampusmat.com/). + +Here's some guidelines for a higher possibility of a merge. +- Write short & descriptive commit messages that follow the [Conventional Commits specification](https://www.conventionalcommits.org) +- Make separate commits for logically separate changes. +- Sign off your patches + + -- cgit v1.2.3-18-g5258