From 7c2ca9d531ab95dfc7936a084f97bf9c9f4b66e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sof=C3=ADa=20Aritz?= Date: Sun, 30 Jun 2024 19:12:09 +0200 Subject: [PATCH] contribution docs --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 39add09..92fb88b 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,19 @@ The recommended Node.JS version is v21.5.0, others should also work. 5. Run `yarn build` to generate the SPA build. * The build will be placed at the `build/` folder. +## Contributing + +Identity is free, open-source software [licensed under AGPL-3.0 and MPL-2.0](#license). + +There are two methods to report bugs, submit patches, etc. +1. **Requesting an account.** Send an e-mail to [sofi@sofiaritz.com](mailto:sofi@sofiaritz.com) or send a Matrix PM to +[@sofiaritz:matrix.org](https://matrix.to/#/@sofiaritz:matrix.org) and she will make an account on your behalf that you can use to create issues and submit patches through pull requests. +2. **E-mail or Matrix.** You can send an e-mail to [sofi@sofiaritz.com](mailto:sofi@sofiaritz.com) or send a Matrix PM to +[@sofiaritz:matrix.org](https://matrix.to/#/@sofiaritz:matrix.org) with suggestions, bug reports, patches, etc. You can submit patches via e-mail +thanks to [git-send-email](https://git-scm.com/docs/git-send-email). + +Choose the method you prefer, for frequent contributors it is recommended to request an account. + ## License * `asset-api` and `identity-api` are licensed under the [AGPL 3.0 license](https://www.gnu.org/licenses/agpl-3.0.en.html).