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
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
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.
Prompt details
- By
- Prompts-GPT editors
- Published
Did this prompt work?
Keep exploring
More like this
Write a README From Your Code and Notes Without Invented Commands
You get a complete README with requirements, install, usage and config sections built only from your pasted code, plus a list of gaps to fill.
Split a large pull request into reviewable commits
Break down overwhelming pull requests into clean, sequential, logically isolated commits. Use it when code reviews stall due to sprawling diffs.
Write a guided walkthrough for a complex pull request
Structure complex multi-file pull requests into a clear, numbered narrative review order for your teammates.
Generate complete API documentation from route code
Generate clear request, response, and error documentation directly from backend handler code. Use it to prepare API docs for frontend developers.
Document module behavior from its test suite
Extract clear business rules, accepted inputs, and edge cases for undocumented modules solely from their test suites.
Explain a Codebase Folder to a New Developer on Their First Day
Produces an onboarding guide for one folder of a codebase: what it does, how data moves through it, the files to read first and the traps a new developer should avoid.
- Audit a stale README against project configuration
- Rebuild local setup instructions from project config files
- Recover from Git commit or branch mistakes safely
- Explain a Confusing Coding Tutorial or Docs Passage in Plain English
- Resolve a Git Merge Conflict and Keep What Both Branches Intended
- Add Docstrings and Why-Focused Comments to Your Pasted Code