From 72cf565547e34aa2e3af9df0c7c264ccdae07a72 Mon Sep 17 00:00:00 2001 From: Emma Date: Fri, 19 Feb 2021 17:21:05 -0800 Subject: [PATCH] Recommendations for enforcement guidelines As per #910 , took a first pass at what recommendations might be for projects and communities where the default guidelines don't quite fit the context/tone of the community. --- content/_index.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/content/_index.md b/content/_index.md index 09e38efc8..c600b2535 100644 --- a/content/_index.md +++ b/content/_index.md @@ -31,6 +31,9 @@ The Contributor Covenant uses semantic versioning for revisions so all URLs are We recommend that you add the Markdown or text version of the Contributor Covenant to your source code repository at the root level. +We recommend that you thoroughly read the Enforcement Guidelines section. If the default version of consequences and their actions do not make sense within the context of your community, consider relocation of this section to another document, like FAQ or 'How to Report' page, that allows you to better describe your guidelines and associated consequences. + + Thanks to [Simon Vansintjan](https://github.com/simonv3/covenant-generator) there is an automated way to add Contributor Covenant to your project. Assuming that you have [Node.js](https://nodejs.org/en/ "Node.js Homepage") installed, simply run the following two commands from your project folder: