Repository guide
Repository review checklist: what to prepare
·
Prepare your repository version, reproduction steps and access restrictions before requesting a code review. Keep secrets and customer records out of shared materials.
Prepare the repository and relevant version
- Record the repository URL and affected branch or commit. Include a public application URL when available. Keep private repositories private; mention access restrictions in the request and agree on the necessary read access separately.
Describe one affected feature first
- Write the expected outcome, actual result, reproduction steps and when it started. Prepare redacted error text if available. “Orders do not appear after payment” is more actionable than “everything is broken.”
Leave out unnecessary sensitive information
- Do not submit API keys, raw .env files, database passwords, session cookies or customer records. Variable names and version information can describe an environment without its secrets. Agree on scope and duration before providing access.
Separate verified facts from open questions before deciding what to change next.
Read next: How to understand an AI-generated repository