Guidelines for contributing to a project, including coding standards, pull request processes, issue reporting, and development setup instructions.
CONTRIBUTING.md
CONTRIBUTING.md is a Markdown file placed at the root of a repository that tells prospective contributors how to participate in a project: how to set up a development environment, which coding standards to follow, how to open issues, and how to shape a pull request that will actually get merged. GitHub, GitLab, and other forges surface it automatically when someone opens a new issue or PR, making it the front door to a project’s collaboration process.
- Onboarding instructions - Environment setup, build steps, and test commands that get a new contributor productive quickly.
- Process expectations - Branching, commit message, review, and pull request conventions that keep contributions consistent.
- Community norms - Pointers to a code of conduct, communication channels, and how decisions get made.
- Platform integration - Automatically linked by GitHub/GitLab from the issue and PR flows, so it meets people at the moment they want to help.
For API providers, CONTRIBUTING.md is where the governance of a public specification or SDK becomes legible — it sets the terms under which the community can change an OpenAPI definition, an SDK, or the docs without breaking downstream consumers. A clear contribution process is one of the machine-readable signals of a healthy, maintained open-source API project, and it increasingly doubles as guidance an AI coding agent can read before proposing a change to the codebase.
Referenced on the API Evangelist blog
Where this standard shows up across sixteen years of my writing at apievangelist.com — how it fits into API design, governance, and the agentic turn.
