From cf7f8b059f7f9b0ea51eef985d5fc146d1704cba Mon Sep 17 00:00:00 2001 From: Ringo De Smet Date: Wed, 17 Nov 2021 20:58:49 +0100 Subject: [PATCH] Elaborated a bit more on the use of this strangely named repository Signed-off-by: Ringo De Smet --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2b4c9f9..e5fe8eb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ -# .github +# Pulumi Community -This is a special repository providing the community guidelines. Read all about the abilities of this repo in the [Github docs](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file). +This repository, named `.github`, is the repository containing the community documentation like: + +* Code of Conduct +* Contributing Guidelines +* Governance Model +* Standard Github Issue Template(s) + +It has the strange name `.github` because, for Github, it offers the option of centrally managing the community +guidelines, while they show up in the Github Web UI of every repository. + +You can read all about the abilities of this repo in the +[Github docs](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file). + +The README file displayed at https://github.com/pulumiverse can be found here: [`profile/README.md`](profile/README.md)