From 9ecffb618d3ef404ee0b0a19277281c2e1e9c7bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Floure?= Date: Thu, 7 May 2020 08:45:21 +0200 Subject: [PATCH] Add CONTIBUTING section to README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 75f6411..4b8dd09 100644 --- a/README.md +++ b/README.md @@ -40,3 +40,16 @@ Join us on [#cdist:ungleich.ch][cdistmatrix] on matrix or on [cdistconfig]: https://www.cdi.st/manual/latest/cdist-configuration.html [cdistmatrix]: https://matrix.to/#/#cdist:ungleich.ch [cdistmattermost]: https://chat.ungleich.ch/ungleich/channels/cdist + +## Contributing + +The preferred way to submit patches is by opening Merge Requests against the +[cdist-contrib project on +code.ungleich.ch](https://code.ungleich.ch/ungleich-public/cdist-contrib) (you +can make an account on +[account.ungleich.ch](https://code.ungleich.ch/ungleich-public/cdist-contrib). + +Every type in cdist-contrib must: + + * Have a `man.rst` documentation page. + * Pass [shellcheck](https://duckduckgo.com/?q=shellcheck&ia=software) without errors.