From 638aa46dede987b8f62697e6a85724d34f57d4d5 Mon Sep 17 00:00:00 2001 From: Sven Greb Date: Fri, 10 Feb 2023 22:24:47 +0100 Subject: [PATCH] Document repository content (#17) To describe the purpose of this repository, the content has been documented in the repository' README. GH-16 --- readme.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/readme.md b/readme.md index 31a1572..bf00885 100644 --- a/readme.md +++ b/readme.md @@ -4,8 +4,35 @@

Community health files for the @nordtheme organization.

+This repository provides default [community health files][1] for the [@nordtheme][2] organization and all its repositories. +This includes all [supported files][3] that can be used universally across Nord repositories: + +- **[`issue_template/config.yml`][15]** — The default [configuration file for the issue template chooser][16] in Nord repositories. +- **[`code_of_conduct.md`][4]** — The [code of conduct][5] that defines Nord‘s community standards and outlines procedures for handling abuse. +- **[`contributing.md`][6]** — General guidelines to communicate [how people should contribute][7] to Nord in order to [build a welcoming community][8]. +- **[`funding.yml`][9]** — The default [configuration file for the sponsor button][10] in Nord repositories. +- **[`security.md`][11]** — The [security][12] policy with instructions for how to [report security vulnerabilities][13] in Nord. +- **[`support.md`][14]** — Instructions for how to ask for help and general Nord community & support resources. +

Copyright © 2016-present Sven Greb

+ +[1]: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file +[2]: https://github.com/nordtheme +[3]: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file#supported-file-types +[4]: https://github.com/nordtheme/.github/blob/main/code_of_conduct.md +[5]: https://opensource.guide/code-of-conduct +[6]: https://github.com/nordtheme/.github/blob/main/contributing.md +[7]: https://opensource.guide/how-to-contribute +[8]: https://opensource.guide/building-community +[9]: https://github.com/nordtheme/.github/blob/main/funding.yml +[10]: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository +[11]: https://github.com/nordtheme/.github/blob/main/security.md +[12]: https://docs.github.com/en/code-security +[13]: https://docs.github.com/en/code-security/security-advisories/repository-security-advisories/about-repository-security-advisories +[14]: https://github.com/nordtheme/.github/blob/main/support.md +[15]: https://github.com/nordtheme/.github/blob/main/issue_template/config.yml +[16]: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser