close
The Wayback Machine - https://web.archive.org/web/20220413084909/https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file
Skip to main content
Free, Pro, & Team
English
Sign up
 
Building communities
Free, Pro, & Team
English
Sign up

 

Creating a default community health file

In this article

You can create default community health files, such as CONTRIBUTING and CODE_OF_CONDUCT. Default files will be used for any 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 a public repository called .github, in the root of the repository or in the docs or .github folders.

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 any of the following places:

  • the root of the repository
  • the .github folder
  • 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.

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 or personal account for the following community health files:

Community health fileDescription
CODE_OF_CONDUCT.mdA 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."
CONTRIBUTING.mdA CONTRIBUTING file communicates how people should contribute to your project. For more information, see "Setting guidelines for repository contributors."
FUNDING.ymlA 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."
Issue and pull request templates and config.ymlIssue 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."
SECURITY.mdA SECURITY file gives instructions for how to report a security vulnerability in your project. For more information, see "Adding a security policy to your repository."
SUPPORT.mdA 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

  1. In the upper-right corner of any page, use the drop-down menu, and select New repository. Drop-down with option to create a new repository
  2. Use the Owner drop-down menu, and select the organization or personal account you want to create default files for. Owner drop-down menu
  3. Type .github as the name for your repository, and an optional description. Create repository field
  4. Make sure the repository status is set to Public (a repository for default files cannot be private). Radio buttons to select private or public status
  5. Select Initialize this repository with a README. Initialize this repository with a README checkbox
  6. Click Create repository. Button to create repository
  7. 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 "Creating new files."