Creating a default community health file for your organization
You can create default community health files, such as CONTRIBUTING and CODE_OF_CONDUCT, for your organization. Default files will be used for any public repository in your organization that does not contain its own file of that type.
In this guide
About default community health files
You can add default community health files for your organization to the root of a public repository called
.github that is owned by the organization.
GitHub will use and display default files for any public repository in the organization that does not have its own file of that type in any of the following places:
- the root of the repository
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, 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
Supported file types
You can create organization-wide defaults for the following community health files:
|Community health file||Description|
|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."|
|CONTRIBUTING.md||A CONTRIBUTING file communicates how people should contribute to your project. For more information, see "Setting guidelines for repository contributors."|
|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."|
|Issue and pull request templates and config.yml||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."|
|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."|
|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 for your organization. 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
In the upper-right corner of any page, use the drop-down menu, and select New repository.
Use the Owner drop-down menu, and select the organization you want to create default files for.
Type .github as the name for your repository, and an optional description.
Choose to make the repository public.
Select Initialize this repository with a README.
Click Create repository.
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 must be in the root of the repository. For more information, see "Creating new files."