Skip to content

Latest commit

 

History

History
65 lines (50 loc) · 6.08 KB

creating-a-default-community-health-file.md

File metadata and controls

65 lines (50 loc) · 6.08 KB
Raw
title intro redirect_from versions topics shortTitle
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 repository owned by the account that does not contain its own file of that type.
/articles/creating-a-default-community-health-file-for-your-organization
/github/building-a-strong-community/creating-a-default-community-health-file-for-your-organization
/github/building-a-strong-community/creating-a-default-community-health-file
fpt ghes ghec
*
*
*
Community
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.

{% 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

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 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.

{% 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."

{% endif %}

Supported file types

You can create defaults in your organization or personal account for the following community health files:

Community health file | Description --- | ---{% ifversion fpt or ghec %} CODE_OF_CONDUCT.md | A CODE_OF_CONDUCT file defines standards for how to engage in a community. For more information, see "AUTOTITLE."{% endif %} CONTRIBUTING.md | A CONTRIBUTING file communicates how people should contribute to your project. For more information, see "AUTOTITLE."{% ifversion discussion-category-forms %} Discussion category forms | Discussion category forms customize the templates that are available for community members to use when they open new discussions in your repository. For more information, see "AUTOTITLE."{% endif %}{% ifversion fpt or ghec %} 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 "AUTOTITLE."{% endif %} GOVERNANCE.md | A GOVERNANCE file lets people know about how your project is governed. For example, it might discuss project roles and how decisions are made. 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 "AUTOTITLE." SECURITY.md | A SECURITY file gives instructions for how to report a security vulnerability in your project. For more information, see "AUTOTITLE." SUPPORT.md | A SUPPORT file lets people know about ways to get help with your project. For more information, see "AUTOTITLE."

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 %}

  1. Use the Owner drop-down menu, and select the organization or personal account you want to create default files for. Screenshot of the owner menu for a new {% data variables.product.prodname_dotcom %} repository. The menu shows two options, octocat and github.
  2. In the "Repository name" field, type .github.
  3. Optionally, in the "Description" field, type a description.
  4. Make sure the repository status is set to Public. A repository for default files cannot be private. {% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.create-repo %}
  5. 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."