caaee7a124
* Add back changes from prior to purge * Manually fix some invalid Liquid * Updoot render-content * Improve test messages to show correct output * Run el scripto * Pass the remaining test
5.2 KiB
title, intro, redirect_from, versions
| title | intro | redirect_from | versions | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Creating a default community health file | You can create default community health files, such as CONTRIBUTING and CODE_OF_CONDUCT. Default files will be used for any public repository owned by the account that does not contain its own file of that type. |
|
|
About default community health files
You can add default community health files to the root of a public repository called .github that is owned by an organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}.
{% data variables.product.product_name %} will use and display default files for any public 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
.githubfolder - the
docsfolder
For example, anyone who creates an issue or pull request in a public 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{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}, including issue templates or a config.yml file,{% endif %} none of the contents of the default .github/ISSUE_TEMPLATE folder will be used.
Default files are not included in clones, packages, or downloads of individual repositories because they are stored only in the .github repository.
Supported file types
You can create defaults in your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %} for the following community health files:
Community health file | Description --- | ---{% if currentVersion == "free-pro-team@latest" %} CODE_OF_CONDUCT.md | A CODE_OF_CONDUCT file defines standards for how to engage in a community. For more information, see "Adding a code of conduct to your project."{% endif %} CONTRIBUTING.md | A CONTRIBUTING file communicates how people should contribute to your project. For more information, see "Setting guidelines for repository contributors."{% if currentVersion == "free-pro-team@latest" %} FUNDING.yml | A FUNDING file displays a sponsor button in your repository to increase the visibility of funding options for your open source project. For more information, see "Displaying a sponsor button in your repository."{% endif %} Issue and pull request templates{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and config.yml{% endif %} | Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository. For more information, see "About issue and pull request templates."{% if currentVersion == "free-pro-team@latest" %} SECURITY.md | A SECURITY file gives instructions for how to responsibly report a security vulnerability in your project. For more information, see "Adding a security policy to your repository."{% endif %} SUPPORT.md | A SUPPORT file lets people know about ways to get help with your project. For more information, see "Adding support resources to your project."
You cannot create a default license file. License files must be added to individual repositories so the file will be included when a project is cloned, packaged, or downloaded.
Creating a repository for default files
{% data reusables.repositories.create_new %}
2. Use the Owner drop-down menu, and select the organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %} you want to create default files for.
3. Type .github as the name for your repository, and an optional description.
4. Choose to make the repository public.
{% data reusables.repositories.initialize-with-readme %}
{% data reusables.repositories.create-repo %}
7. In the repository, create one of the supported community health files. Issue templates{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and their configuration file{% endif %} must be in a folder called .github/ISSUE_TEMPLATE. All other supported files must be in the root of the repository. For more information, see "Creating new files."