CONTRIBUTING.md Related Conventions

aid: contributing-md:related-conventions
name: CONTRIBUTING.md Related Conventions
tags:
- Community Health
- Convention
- GitHub
- Open Source
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
humanURL: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions
properties:
- url: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories
  type: Documentation
- url: https://www.contributor-covenant.org/
  type: Reference
- url: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests
  type: Documentation
description: CONTRIBUTING.md is one of several community health files GitHub looks for when scoring a
  repository community profile. Sibling files include README.md, LICENSE, CODE_OF_CONDUCT.md, SECURITY.md,
  SUPPORT.md, and issue and pull request templates. Together these conventions establish a well-formed,
  welcoming open source project that lowers the barrier for new contributors.
x-features:
- Recognized as part of the GitHub community profile checklist
- Composable with CODE_OF_CONDUCT.md, SECURITY.md, and SUPPORT.md
- Compatible with All Contributors specification for recognition
- Often pairs with .github/ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE.md
x-useCases:
- Completing the GitHub community profile health checklist
- Defining the entire community health surface for an organization
- Standardizing contribution conventions across many repositories