Is a CONTRIBUTING.md file required?

It is not required but is considered best practice for any project that accepts contributions. GitHub surfaces it automatically when a contributor opens a pull request or issue.

What is Conventional Commits?

Conventional Commits is a specification for commit messages using a structured format (type: description). It enables automated changelog generation, semantic versioning, and clearer git history.

Should I include a Code of Conduct?

Yes. A code of conduct sets clear behavioral expectations and is required by many open-source foundations. The Contributor Covenant is widely adopted and requires only minor customization.

Write a CONTRIBUTING Guide

A contributing guide reduces friction for new contributors by explaining how to set up the project, report issues, submit pull requests, and follow code style conventions. This template covers development setup, the PR process, commit message format, and the code of conduct reference. Preview the rendered output to confirm heading hierarchy and link formatting before adding the file to your repository. Pinning the contributing guide in the repository description helps first-time contributors find it quickly.

Example

# Contributing to Project Name

Thank you for considering a contribution!

## Reporting Issues

Before opening an issue, search existing issues to avoid duplicates.
Include: steps to reproduce, expected vs actual behavior, and version info.

## Development Setup

```bash
git clone https://github.com/user/repo
cd repo
npm install
npm run dev
```

## Pull Request Process

1. Fork the repository and create a feature branch
2. Make your changes with tests
3. Run `npm test` and `npm run lint`
4. Submit a PR with a clear description of the change

## Commit Messages

Follow [Conventional Commits](https://www.conventionalcommits.org/):
- `feat: add dark mode`
- `fix: correct timezone handling`
- `docs: update API reference`

## Code of Conduct

This project follows the [Contributor Covenant](https://www.contributor-covenant.org/).

[ open in Markdown Previewer → ]

FAQ

Is a CONTRIBUTING.md file required?: It is not required but is considered best practice for any project that accepts contributions. GitHub surfaces it automatically when a contributor opens a pull request or issue.
What is Conventional Commits?: Conventional Commits is a specification for commit messages using a structured format (type: description). It enables automated changelog generation, semantic versioning, and clearer git history.
Should I include a Code of Conduct?: Yes. A code of conduct sets clear behavioral expectations and is required by many open-source foundations. The Contributor Covenant is widely adopted and requires only minor customization.

Related Examples

Write a Project README in Markdown

A good README is the front door of every open-source project and sets the tone f...

Write a CHANGELOG in Markdown

A structured changelog tells users what changed between versions and why, buildi...

Pull Request Description Template

A consistent pull request template speeds up code review by ensuring authors inc...