# CONTRIBUTING File

> A file that tells people how to help with a project. It covers bugs and code.

**Field:** Software Development  
**Category:** Product & Releases  
**Also known as:** CONTRIBUTING.md, Contributing Guide, Contribution Guidelines

## Think of it like

It is like the rules sheet by a shared garden. It tells new helpers how to pitch in.

## Definition

A CONTRIBUTING file tells people how to help with a project. It explains how to report a bug, how to set up the code, and how to send a change. It may also say how code should be styled and tested. It usually lives in the project's top folder as CONTRIBUTING.md. On GitHub, a link to it shows up when someone opens an issue or a pull request.

## Example

Emma wants to fix a typo in a big project. The CONTRIBUTING file tells her to make a branch, run the tests and open a pull request.

## Example code

```markdown
## How to help
1. Fork the repo and make a branch.
2. Run npm test before you push.
3. Open a pull request with a short summary.
```

Three steps from a CONTRIBUTING.md file. New helpers do them in order.

## Why it matters

New helpers know what to do, and maintainers get changes in the shape they need. Fewer pull requests get turned away.

## Common mistake

Writing a long rule book nobody reads. Keep it short, and put the first step at the top.

## Three principles

- **How to help.** Bugs, setup and changes.
- **In the top folder.** Named CONTRIBUTING.md.
- **Linked by GitHub.** Shown on new issues and pull requests.

## Related terms

- [Software Documentation](https://learn.benibix.com/term/development/documentation)
- [README File](https://learn.benibix.com/term/development/readme)
- [Open Source Software](https://learn.benibix.com/term/development/open-source)
- [Pull Request](https://learn.benibix.com/term/development/pull-request)
- [Changelog](https://learn.benibix.com/term/development/changelog)

## Taught in

- [Pull Requests and Forks](https://learn.benibix.com/learn/development-version-control/pull-requests-and-forks): Git and GitHub, 11/13

![A project folder with five files, each with its job: README.md says what the project is, LICENSE says how you may use it, CONTRIBUTING.md says how to help, CODE_OF_CONDUCT.md says how to behave, and CHANGELOG.md lists what changed. CONTRIBUTING.md is marked in the accent colour, with a note that GitHub links to it when someone opens an issue or pull request.](https://learn.benibix.com/diagrams/dev5-repo-files.svg)

---

Source: https://learn.benibix.com/term/development/contributing-file
Author: Behnia Zarei (a developer in Vienna, Austria, who builds and teaches data, AI and business intelligence at BENIBIX)
Publisher: BENIBIX Learn (https://learn.benibix.com/)
Last updated: 2026-11-19
Licence: CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Quote freely with attribution.
