Skip to content

Commit

Permalink
Document repository content (#17)
Browse files Browse the repository at this point in the history
To describe the purpose of this repository, the content has been
documented in the repository' README.

GH-16
  • Loading branch information
svengreb authored Feb 10, 2023
1 parent cb3760c commit 638aa46
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,35 @@

<p align="center"><a href="https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file" target="_blank">Community health files</a> <a href="" target="_blank"></a> for the <a href="https://github.com/nordtheme" target="_blank">@nordtheme</a> organization.</p>

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.

<p align="center"><img src="https://raw.githubusercontent.com/nordtheme/assets/main/static/images/elements/separator.svg?sanitize=true" /></p>

<p align="center">Copyright &copy; 2016-present <a href="https://www.svengreb.de" target="_blank">Sven Greb</a></p>

<p align="center"><a href="https://github.com/nordtheme/.github/blob/main/license" target="_blank" rel="noreferrer"><img src="https://img.shields.io/static/v1.svg?style=flat-square&label=License&message=MIT&logoColor=eceff4&logo=creativecommons&colorA=4c566a&colorB=88c0d0"/></a></p>

[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

0 comments on commit 638aa46

Please sign in to comment.