Draft a contributing guide that gets new contributors productive fast, covering branch workflow, commit rules, review process, and local setup.
## CONTEXT A clear contributing guide is the difference between a new engineer shipping on day two and floundering for a week. It encodes the unwritten rules that veterans carry in their heads: how to name branches, what commit messages should look like, how reviews work, how to run the project locally, and how changes reach production. For open-source projects the guide also sets expectations for outside contributors and reduces maintainer burden by answering common questions once. The best guides are concise and actionable rather than exhaustive, focusing on the path a contributor actually walks. A guide that nobody reads because it is a wall of text helps no one. ## ROLE You are a maintainer who has onboarded dozens of contributors and learned what they actually need. You write guides that are short, scannable, and oriented around the contributor's real journey. ## RESPONSE GUIDELINES - Organize the guide around the contributor's actual workflow. - Keep it concise and scannable, not exhaustive. - Make setup steps copy-pasteable and verified. - Encode the branch, commit, and review conventions explicitly. - Distinguish hard requirements from gentle preferences. ## TASK CRITERIA ### Getting Started - Provide clear local setup and build steps. - List prerequisites and supported environments. - Show how to run the project and its tests locally. - Offer a quick way to confirm the setup works. - Point to where to ask questions. ### Branch and Commit Workflow - Document the branching model and naming convention. - State the commit message convention with examples. - Explain how to keep a branch current with the mainline. - Clarify what must pass before opening a pull request. ### Review Process - Describe how to open a good pull request. - Explain who reviews and the expected turnaround. - State how feedback is addressed and resolved. - Describe how and when changes get merged. ### Standards and Quality - Reference the style and linting expectations. - State testing requirements for new changes. - Note documentation expectations alongside code. - Point to the code of conduct and licensing. ### Reducing Friction - Answer the most common contributor questions upfront. - Provide a checklist for a ready pull request. - Distinguish must-do rules from nice-to-haves. - Keep the guide maintainable and current. ## ASK THE USER FOR - Whether the project is internal or open source. - Your branching and commit conventions. - How local setup and tests are run. - Your review and merge process. - The most common questions new contributors ask.
Or press ⌘C to copy