jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 09:57:42 -05:00
Code Issues Projects Releases Wiki Activity

Updated doc - .github can be public or internal (#58538)

Browse Source 
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
This commit is contained in:
Harry Cross
2025-11-21 11:47:34 +00:00
committed by GitHub
parent 653e54c7bf
commit e338dcfc75
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md
View File

@@ -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` and {% data variables.product.github %} 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**{% ifversion ghec or ghes %} or **internal**{% endif %} repository called `.github` and {% data variables.product.github %} 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:
* The `.github` folder
* The root of the repository
@@ -26,7 +26,7 @@ You can add default community health files to a public repository called `.githu
If no corresponding file is found in the current repository, {% data variables.product.github %} will use the default file from the `.github` repository, following the same order of precedence.
**Note:** The `.github` repository must be **public** for templates to be applied organization-wide. Private `.github` repositories are not supported.
**Note:** The `.github` repository must be **public**{% ifversion ghec or ghes %} or **internal**{% endif %} for templates to be applied organization-wide. Private `.github` repositories are not supported.
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.
@@ -66,7 +66,7 @@ You cannot create a default license file. License files must be added to individ
![Screenshot of the owner menu for a new {% data variables.product.prodname_dotcom %} repository. The menu shows two options, octocat and github.](/assets/images/help/repository/create-repository-owner.png)
1. In the "Repository name" field, type **.github**.
1. Optionally, in the "Description" field, type a description.
1. Make sure the repository status is set to **Public**. A repository for default files cannot be private.
1. Make sure the repository status is set to **Public**{% ifversion ghec or ghes %} or **Internal**{% endif %}. A repository for default files cannot be private.
{% data reusables.repositories.initialize-with-readme %}
{% data reusables.repositories.create-repo %}
1. In the repository, create one of the supported community health files. Issue templates and their configuration file must be in a folder called `.github/ISSUE_TEMPLATE`. All other supported files may be in the root of the repository, the `.github` folder, or the `docs` folder. For more information, see [AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files).