About community profiles for public repositories

Repository maintainers can review their public repository's community profile to learn how they can help grow their community and support contributors. Contributors can view a public repository's community profile to see if they want to contribute to the project.

The community profile checklist checks to see if a project includes recommended community health files, such as README, CODE_OF_CONDUCT, LICENSE, or CONTRIBUTING, in a supported location. For more information, see "Accessing a project's community profile."

Using the community profile checklist as a repository maintainer

As a repository maintainer, use the community profile checklist to see if your project meets the recommended community standards to help people use and contribute to your project. For more information, see "Building community" in the Open Source Guides.

If a project doesn't have a recommended file, you can click Add to draft and submit a file.

To be included in the community profile checklist, issue templates must be located in the .github/ISSUE_TEMPLATE folder and contain valid name: and about: YAML front matter. For more information, see "About issue and pull request templates."

Community profile checklist with recommended community standards for maintainers

You can create a security policy to give people instructions for responsibly reporting security vulnerabilities in your project. For more information, see "Adding a security policy to your repository."

Using the community profile checklist as a community member or collaborator

As a potential contributor, use the community profile checklist to see if a project meets the recommended community standards and decide if you'd like to contribute. For more information, see "How to contribute" in the Open Source Guides.

If a project doesn't have a recommended file, you can click Propose to draft and submit a file to the repository maintainer for approval.

Community profile checklist with recommended community standards for contributors

Further reading

Ask a human

Can't find what you're looking for?

Contact us