naorpeled Repository onboarding
Use this skill when a contributor needs a fast, reliable orientation to a repository before making changes.
Primary inputs
README.mdCONTRIBUTING.mdDEVELOPER.md,developer.md, ordocs/development.mdCODE_OF_CONDUCT.mdSECURITY.md- issue templates and pull request templates
- architecture or docs folders
Instructions
- Read the repository's high-signal docs first.
- Summarize:
- what the project does
- who it is for
- how contributors are expected to work
- Extract the contributor workflow:
- setup steps
- build, test, and lint commands
- branching or commit expectations
- pull request expectations
- Identify project norms:
- code of conduct or communication rules
- security reporting instructions
- labels or issue types that indicate where help is needed
- End with the smallest sensible next steps for the contributor.
Recommendations to apply
- Prefer reading the room before suggesting changes.
- Point new contributors to documentation and small starter work first.
- Highlight non-code ways to contribute when the repository supports them.
- If the repo uses labels such as
good first issueorhelp wanted, call them out explicitly.
Output format
Return:
- a short repository summary
- a checklist of first setup steps
- the most important repo norms
- a list of suggested next tasks for a newcomer