Generate a CONTRIBUTING.md for Your Project
A missing or outdated CONTRIBUTING.md means every new contributor asks the same questions in issues or PRs. Claude can read your project structure and write a complete guide in one pass.
Read the project structure, package.json, and any existing docs,
then write a CONTRIBUTING.md. Include: how to set up the dev
environment, branching and commit message conventions, how to
run tests, the PR process, and code style guidelines.
Claude produces a guide tailored to your actual stack — not a generic template:
## Development Setup
1. Clone the repo and install dependencies:
\`\`\`bash
git clone https://github.com/you/project
npm install
cp .env.example .env
\`\`\`
2. Start the development server: `npm run dev`
## Branching Convention
- `feature/short-description` for new features
- `fix/short-description` for bug fixes
- Branch from `main`, PR back to `main`
## Running Tests
\`\`\`bash
npm run test # unit tests
npm run test:e2e # Playwright E2E suite
\`\`\`
You can ask Claude to tailor the tone too — formal for enterprise OSS, casual for a personal project. It will also add sections for first-time contributors, a code of conduct pointer, and a "good first issue" guide if you ask.
A good CONTRIBUTING.md is a force multiplier — it answers questions before they're asked and makes your repo approachable to contributors who don't know you.
Log in to leave a comment.
The /security-review command scans your uncommitted changes for injection vectors, auth gaps, hardcoded secrets, and other common vulnerabilities.
The SessionStart hook fires when any session begins or resumes, making it ideal for loading environment variables and running one-time setup scripts.
Ask Claude to write property-based tests for your functions using fast-check — it identifies the mathematical invariants in your code and generates tests that cover inputs you'd never enumerate by hand.