From 60f1750a24948fc1597da3a00b44a75d2eb8e0b1 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 10 Aug 2024 10:58:40 +0200 Subject: [PATCH 1/9] Update creating-a-default-community-health-file.md --- .../creating-a-default-community-health-file.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index 65d4037b7cf2..bb568af59480 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -21,9 +21,12 @@ You can add default community health files to a public repository called `.githu {% data variables.product.product_name %} will use and display default files for any repository owned by the account that does not have its own file of that type in any of the following places: -* The root of the repository -* The `.github` folder -* The `docs` folder +1. The `.github` folder +1. The root of the repository +1. The `docs` folder +1. The `.github` folder in the `.github` repository. +1. The root of the `.github` repository. +1. The `docs` folder in the `.github` repository. For example, anyone who creates an issue or pull request in a repository that does not have its own CONTRIBUTING file will see a link to the default CONTRIBUTING file. If a repository has any files in its own `.github/ISSUE_TEMPLATE` folder, including issue templates or a _config.yml_ file, none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used. From 0f14ae3b83cce35ef87f28112ab5eddcd48815fe Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 10 Aug 2024 11:11:55 +0200 Subject: [PATCH 2/9] Fix order and lists --- .../creating-a-default-community-health-file.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index bb568af59480..45e1d4effede 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -19,14 +19,16 @@ shortTitle: Community health file Default community health files are a set of predefined files that provide guidance and templates for maintaining a healthy and collaborative open source project. You can add default community health files to a public repository called `.github`, in the root of the repository or in the `docs` or `.github` folders. These files help you automate and standardize various aspects of your project's development and community interaction. They are essential for promoting transparency, good practices, and collaboration in open source projects. -{% data variables.product.product_name %} will use and display default files for any repository owned by the account that does not have its own file of that type in any of the following places: +{% data variables.product.product_name %} will use and display default files for any repository owned by the account that does not have its own file of that type in the following order: -1. The `.github` folder -1. The root of the repository -1. The `docs` folder -1. The `.github` folder in the `.github` repository. -1. The root of the `.github` repository. -1. The `docs` folder in the `.github` repository. +1. Local repository: + 1. The `.github` folder. + 1. The root of the repository. + 1. The `docs` folder. +1. The `.github` repository: + 1. The `.github` folder. + 1. The root of the repository. + 1. The `docs` folder. For example, anyone who creates an issue or pull request in a repository that does not have its own CONTRIBUTING file will see a link to the default CONTRIBUTING file. If a repository has any files in its own `.github/ISSUE_TEMPLATE` folder, including issue templates or a _config.yml_ file, none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used. From 4ef4dc3d6e91865fccba57fb20141c6104e43d40 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 10 Aug 2024 11:26:19 +0200 Subject: [PATCH 3/9] test --- .../creating-a-default-community-health-file.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index 45e1d4effede..8c697fba0921 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -22,13 +22,13 @@ You can add default community health files to a public repository called `.githu {% data variables.product.product_name %} will use and display default files for any repository owned by the account that does not have its own file of that type in the following order: 1. Local repository: - 1. The `.github` folder. - 1. The root of the repository. - 1. The `docs` folder. + 1. The `.github` folder. + 1. The root of the repository. + 1. The `docs` folder. 1. The `.github` repository: - 1. The `.github` folder. - 1. The root of the repository. - 1. The `docs` folder. + 1. The `.github` folder. + 1. The root of the repository. + 1. The `docs` folder. For example, anyone who creates an issue or pull request in a repository that does not have its own CONTRIBUTING file will see a link to the default CONTRIBUTING file. If a repository has any files in its own `.github/ISSUE_TEMPLATE` folder, including issue templates or a _config.yml_ file, none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used. From 8224cc7081303dea95ef0ff410e6c13a09b9f418 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 18 Aug 2024 12:35:49 +0200 Subject: [PATCH 4/9] Better integration of message into existing article --- ...reating-a-default-community-health-file.md | 29 ++++++++++--------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index 8c697fba0921..111fe2c2e198 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -16,23 +16,26 @@ shortTitle: Community health file ## About default community health files -Default community health files are a set of predefined files that provide guidance and templates for maintaining a healthy and collaborative open source project. -You can add default community health files to a public repository called `.github`, in the root of the repository or in the `docs` or `.github` folders. These files help you automate and standardize various aspects of your project's development and community interaction. They are essential for promoting transparency, good practices, and collaboration in open source projects. +Default community health files are a set of predefined files that provide guidance and templates for maintaining a healthy and collaborative open source project. These files help you automate and standardize various aspects of your project's development and community interaction, promoting transparency, good practices, and collaboration. -{% data variables.product.product_name %} will use and display default files for any repository owned by the account that does not have its own file of that type in the following order: +You can add default community health files to a public repository called `.github`. {% data variables.product.product_name %} will use and display default files for any repository owned by the account that does not have its own file of that type. The location of these default files determines whether and how they will be used. -1. Local repository: - 1. The `.github` folder. - 1. The root of the repository. - 1. The `docs` folder. -1. The `.github` repository: - 1. The `.github` folder. - 1. The root of the repository. - 1. The `docs` folder. +### File Location and Precedence -For example, anyone who creates an issue or pull request in a repository that does not have its own CONTRIBUTING file will see a link to the default CONTRIBUTING file. If a repository has any files in its own `.github/ISSUE_TEMPLATE` folder, including issue templates or a _config.yml_ file, none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used. +When a repository does not contain its own file of a specific type, {% data variables.product.product_name %} will look for a default file in the following order: -Default files won’t appear in the file browser or Git history and are not included in clones, packages, or downloads of individual repositories because they are stored only in the `.github` repository. +1. **Within the Local Repository**: + 1. `.github` folder + 1. Root of the repository + 1. `docs` folder +1. **Within the `.github` Repository**: + 1. `.github` folder + 1. Root of the repository + 1. `docs` folder + +For example, if a repository does not have its own CONTRIBUTING file, the local `.github` folder will be checked first, then the root, followed by the `docs` folder. If none of these locations contain the file, it will then check the `.github` repository in the same order. + +Default files are not displayed in the file browser, are not part of the Git history, and are excluded from clones, packages, or downloads of individual repositories because they exist only in the `.github` repository. {% ifversion fpt or ghec %} From d10b497a7e1cdcc2a08a0a317c378ad6894dfda4 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 18 Aug 2024 12:37:52 +0200 Subject: [PATCH 5/9] Adding back the example of limiting inheritance from any default location --- .../creating-a-default-community-health-file.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index 111fe2c2e198..1e1b2264c401 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -33,9 +33,11 @@ When a repository does not contain its own file of a specific type, {% data vari 1. Root of the repository 1. `docs` folder -For example, if a repository does not have its own CONTRIBUTING file, the local `.github` folder will be checked first, then the root, followed by the `docs` folder. If none of these locations contain the file, it will then check the `.github` repository in the same order. +### Limiting Usage of Default Files -Default files are not displayed in the file browser, are not part of the Git history, and are excluded from clones, packages, or downloads of individual repositories because they exist only in the `.github` repository. +For example, if anyone creates an issue or pull request in a repository that does not have its own CONTRIBUTING file, they will see a link to the default CONTRIBUTING file. However, if the repository has any files in its own `.github/ISSUE_TEMPLATE` folder, including issue templates or a _config.yml_ file, none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used. This rule allows you to override the default files selectively by providing specific templates or configurations in the local repository. + +Default files do not appear in the file browser, are not part of the Git history, and are excluded from clones, packages, or downloads of individual repositories because they exist only in the `.github` repository. {% ifversion fpt or ghec %} From 7daf4165a8f7f0de52829cf144c426fcfa0d63e6 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 18 Aug 2024 12:41:33 +0200 Subject: [PATCH 6/9] Restructure without the use of a separate chapter for limitations --- .../creating-a-default-community-health-file.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index 1e1b2264c401..8dfcf65fd29a 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -18,7 +18,7 @@ shortTitle: Community health file Default community health files are a set of predefined files that provide guidance and templates for maintaining a healthy and collaborative open source project. These files help you automate and standardize various aspects of your project's development and community interaction, promoting transparency, good practices, and collaboration. -You can add default community health files to a public repository called `.github`. {% data variables.product.product_name %} will use and display default files for any repository owned by the account that does not have its own file of that type. The location of these default files determines whether and how they will be used. +You can add default community health files to a public repository called `.github`. {% data variables.product.product_name %} will use and display default files for any repository owned by the account that does not have its own file of that type. The location of these default files determines whether and how they will be used. ### File Location and Precedence @@ -33,9 +33,11 @@ When a repository does not contain its own file of a specific type, {% data vari 1. Root of the repository 1. `docs` folder -### Limiting Usage of Default Files +If no corresponding file is found in the local repository, {% data variables.product.product_name %} will use the default file from the `.github` repository, following the same order of precedence. -For example, if anyone creates an issue or pull request in a repository that does not have its own CONTRIBUTING file, they will see a link to the default CONTRIBUTING file. However, if the repository has any files in its own `.github/ISSUE_TEMPLATE` folder, including issue templates or a _config.yml_ file, none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used. This rule allows you to override the default files selectively by providing specific templates or configurations in the local repository. +For example, if someone creates an issue or pull request in a repository that does not have its own `CONTRIBUTING.md` file, {% data variables.product.product_name %} will check the local repository first and, if no file is found, it will fall back to the default `CONTRIBUTING.md` in the `.github` repository. + +However, if a repository contains any files in its own `.github/ISSUE_TEMPLATE` folder, such as issue templates or a `_config.yml` file, none of the contents of the default `.github/ISSUE_TEMPLATE` folder in the `.github` repository will be used. This allows repository maintainers to override the default files with specific templates or configurations as needed. Default files do not appear in the file browser, are not part of the Git history, and are excluded from clones, packages, or downloads of individual repositories because they exist only in the `.github` repository. From bfb40a1f1045b43f2f1c446cbc66c748c1c0e896 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 18 Aug 2024 12:46:38 +0200 Subject: [PATCH 7/9] Fix linter issue --- .../creating-a-default-community-health-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index 8dfcf65fd29a..303041c35d2b 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -35,7 +35,7 @@ When a repository does not contain its own file of a specific type, {% data vari If no corresponding file is found in the local repository, {% data variables.product.product_name %} will use the default file from the `.github` repository, following the same order of precedence. -For example, if someone creates an issue or pull request in a repository that does not have its own `CONTRIBUTING.md` file, {% data variables.product.product_name %} will check the local repository first and, if no file is found, it will fall back to the default `CONTRIBUTING.md` in the `.github` repository. +For example, if someone creates an issue or pull request in a repository that does not have its own `CONTRIBUTING.md` file, {% data variables.product.product_name %} will check the local repository first and, if no file is found, it will fall back to the default `CONTRIBUTING.md` in the `.github` repository. However, if a repository contains any files in its own `.github/ISSUE_TEMPLATE` folder, such as issue templates or a `_config.yml` file, none of the contents of the default `.github/ISSUE_TEMPLATE` folder in the `.github` repository will be used. This allows repository maintainers to override the default files with specific templates or configurations as needed. From f524a38c8b8f3c5d6cca892971d8045c382ac940 Mon Sep 17 00:00:00 2001 From: Jan Brasna <1784648+janbrasna@users.noreply.github.com> Date: Thu, 14 Nov 2024 20:25:47 +0100 Subject: [PATCH 8/9] Simplify creating-a-default-community-health-file changes --- ...reating-a-default-community-health-file.md | 25 +++++-------------- 1 file changed, 6 insertions(+), 19 deletions(-) diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index 020bc17dd8a4..e18a3454c82e 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -18,28 +18,15 @@ shortTitle: Community health file Default community health files are a set of predefined files that provide guidance and templates for maintaining a healthy and collaborative open source project. These files help you automate and standardize various aspects of your project's development and community interaction, promoting transparency, good practices, and collaboration. -You can add default community health files to a public repository called `.github`. {% data variables.product.product_name %} will use and display default files for any repository owned by the account that does not have its own file of that type. The location of these default files determines whether and how they will be used. +You can add default community health files to a public repository called `.github` and {% data variables.product.product_name %} will use and display default files for any repository owned by the account that does not have its own file of that type in the following order: -### File Location and Precedence +* The `.github` folder +* The root of the repository +* The `docs` folder -When a repository does not contain its own file of a specific type, {% data variables.product.product_name %} will look for a default file in the following order: +If no corresponding file is found in the current repository, {% data variables.product.product_name %} will use the default file from the `.github` repository, following the same order of precedence. -1. **Within the Local Repository**: - 1. `.github` folder - 1. Root of the repository - 1. `docs` folder -1. **Within the `.github` Repository**: - 1. `.github` folder - 1. Root of the repository - 1. `docs` folder - -If no corresponding file is found in the local repository, {% data variables.product.product_name %} will use the default file from the `.github` repository, following the same order of precedence. - -For example, if someone creates an issue or pull request in a repository that does not have its own `CONTRIBUTING.md` file, {% data variables.product.product_name %} will check the local repository first and, if no file is found, it will fall back to the default `CONTRIBUTING.md` in the `.github` repository. - -However, if a repository contains any files in its own `.github/ISSUE_TEMPLATE` folder, such as issue templates or a `_config.yml` file, none of the contents of the default `.github/ISSUE_TEMPLATE` folder in the `.github` repository will be used. This allows repository maintainers to override the default files with specific templates or configurations as needed. - -Default files do not appear in the file browser, are not part of the Git history, and are excluded from clones, packages, or downloads of individual repositories because they exist only in the `.github` repository. +For example, anyone who creates an issue or pull request in a repository that does not have its own `CONTRIBUTING.md` file will see a link to the default `CONTRIBUTING.md` from the `.github` repository. However, if a repository has any files in its own `.github/ISSUE_TEMPLATE` folder, such as issue templates or a `_config.yml` file, none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used. This allows repository maintainers to override the default files with specific templates or content on per-repository basis. {% ifversion fpt or ghec %} From 74e045603c32c440773400f96226cffb0c8e3a47 Mon Sep 17 00:00:00 2001 From: Jan Brasna <1784648+janbrasna@users.noreply.github.com> Date: Thu, 14 Nov 2024 21:03:23 +0100 Subject: [PATCH 9/9] Update default repo wording --- .../creating-a-default-community-health-file.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index e18a3454c82e..e51c52592e52 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -28,6 +28,8 @@ If no corresponding file is found in the current repository, {% data variables.p For example, anyone who creates an issue or pull request in a repository that does not have its own `CONTRIBUTING.md` file will see a link to the default `CONTRIBUTING.md` from the `.github` repository. However, if a repository has any files in its own `.github/ISSUE_TEMPLATE` folder, such as issue templates or a `_config.yml` file, none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used. This allows repository maintainers to override the default files with specific templates or content on per-repository basis. +Storing the files in `.github` repository allows making changes to the defaults just in one place. Additionally, they won’t appear in the file browser or Git history of the individual repositories, and are not included in their clones, packages, or downloads. + {% ifversion fpt or ghec %} As a repository maintainer, you can use the community standards checklist to see if your project meets the recommended community standards to help people use and contribute to your project. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)."