How to write a CONTRIBUTING guide

CONTRIBUTING guide · docs.contributing

Why it matters

A contribution guide answers the questions every first-time contributor asks — how to run tests, which branch, what a good pull request looks like.

How to fix it

What to do: Create CONTRIBUTING.md with contributor instructions.

# Contributing Guide

## Getting started
1. Fork the repository
2. Create a branch: git checkout -b feat/my-feature
3. Commit: git commit -m "feat: add feature"
4. Run tests: pytest
5. Open a Pull Request

## Code style
- Format: ruff format .
- Lint: ruff check .

Does your repository pass this check?

Free for public GitHub repositories, no account needed. 50+ DevOps and security checks in about ten seconds.

Public repositories where this check fails

Related checks