Create a contributing guide and pull request checklist

Generate a clear, friction-free onboarding guide and pull request checklist for new contributors to your repository.

You getCode of Conduct / Tone note, local Development Setup and branch & Commit Conventions

Prompt

Prompt
Act as an open-source maintainer creating onboarding documentation.
Ask me 3 short numbered questions in one message and wait for my response:
1. What is the tech stack, package manager, and test runner used?
2. What branch naming, commit conventions (e.g., Conventional Commits), or linting rules must contributors follow?
3. What local steps must pass before opening a PR (e.g., formatting, unit tests, migrations)?
Once I reply, generate a complete CONTRIBUTING.md file.
Output format:
- Code of Conduct / Tone note (1 sentence)
- Local Development Setup (numbered commands)
- Branch & Commit Conventions (rules and concrete examples)
- Pre-Flight Checklist (checkboxes for authors before submitting PRs)

Example output

Example for: Python FastAPI repo using Poetry and pytest

Contributing to Project

We value constructive feedback, concise pull requests, and respect for all contributors.

Local Development Setup

  1. Fork and clone the repository:
    git clone https://github.com/example/repo.git && cd repo
  2. Install dependencies with Poetry:
    poetry install
  3. Activate virtual environment and verify tests:
    poetry run pytest

Branch & Commit Conventions

  • Prefix branch names with the issue type: fix/short-description, feat/short-description, or chore/short-description.
  • Follow Conventional Commits format: <type>(<scope>): <subject> (e.g., feat(auth): validate expired jwt tokens).
  • Keep commit messages in the imperative present tense.

Pre-Flight Checklist

Before submitting your pull request, verify that:

  • [ ] My branch is rebased onto the latest main branch.
  • [ ] Code formats cleanly with poetry run ruff format ..
  • [ ] Linter checks pass with poetry run ruff check ..
  • [ ] All existing and new tests pass with poetry run pytest.
  • [ ] Relevant documentation or docstrings were added or updated.
Written by AI from this prompt. Your results will vary.

Send the prompt into ChatGPT, Claude, or Gemini. The model will prompt you with three brief questions; paste your tooling details to receive a production-ready CONTRIBUTING.md.

Make it repeatable

Keep using this prompt without pasting it in every time.

Keep exploring

More in Coding