Project guides

CONTRIBUTING.md template for an open source repository

A CONTRIBUTING.md file helps someone move from “I want to help” to a useful issue or pull request. Explain the smallest supported contribution and how to verify it. Requirements should reflect how your project actually works, not an ambitious process nobody follows.

GitHubStart editorial team · Updated

Copy and adapt the contribution template

Replace the placeholders and verify every command and link. Keep documentation corrections and bug reports welcome even when a contributor is not ready to change application code.

# Contributing

## Before starting
Read the README and check existing issues.
For large changes, discuss the approach before implementing it.

## Local setup
[Required runtime and verified setup commands]

## Report a bug
Include the version, environment, steps, expected result and actual result.
Remove secrets and personal data from logs.

## Submit a pull request
- Explain the problem and the proposed change.
- Keep the change focused.
- Run [the project-specific checks].
- Update affected documentation.

## Review
[Who reviews, how to respond, and realistic availability]

## Other ways to help
[Documentation, examples, translations or reproducible reports]

Make the guidelines easy to find

GitHub recognizes contribution guidelines in the repository root, docs or .github directories. Link the file from your README too, so someone reading the project introduction can find the process immediately.

Review the path from the repository’s actual contribution entry points. If several guideline files exist, consolidate conflicting instructions. A contributor should not receive one setup command in the README and a different unsupported command in the contribution guide.

Design one approachable first contribution

Choose a small task with a clear result, such as correcting an example for a supported runtime. Explain how to reproduce the issue, which behavior should change and how to check completion. Avoid labeling a task as beginner-friendly if it depends on undocumented internal knowledge.

State your review availability honestly. If you cannot promise a response time, say how contributors can check the status instead. Clear boundaries reduce abandoned work and are more useful than promising to merge every contribution.

Common questions

Does CONTRIBUTING.md replace README.md?

No. The README explains the project and how to use it. Contribution guidelines explain how to propose and verify changes.

Should I copy another project’s test commands?

Only if they are also the correct commands for your project. Replace placeholders with commands you have actually checked.

Do contribution guidelines guarantee more contributors?

No. They reduce uncertainty for interested people, but the project’s usefulness, task quality and maintainer follow-up still matter.

References