GitHub Repository Onboarding Guide for New Developers
Write a first-week guide for a codebase.
The Open buttons send the prompt text as currently shown below to that site only when you click. Fill in the placeholders first.
Write an onboarding guide for new developers joining [TEAM]. Repositories and what each does: [REPOSITORIES]. Tools to install: [TOOLS]. Environments and access requests: [ACCESS]. Architecture notes: [ARCHITECTURE_NOTES]. First tasks suitable for newcomers: [FIRST_TASKS]. Write for someone smart but new to this codebase. Provide a first-week plan by day with time estimates: day one access and setup (4 hours), day two architecture notes and running the tests (4 hours), day three a small guided change (3 hours), day four pairing on a review (3 hours), day five a first independent task and a retrospective. Detail the first two days with the expected result of each step; give a result such as a passing test count only if I supplied it, otherwise use a placeholder. Add a setup checklist, a map of the code as a table of directory, purpose and owner, how to run and test, how a change moves to production, how to ask for help, a glossary, and a list of good first issues. Include the first small task step by step so the newcomer experiences the whole cycle of branch, change, test, pull request and review. Add team working agreements (pull request size, review times, communication), ten questions a newcomer should be able to answer by the end of week one, and a buddy checklist. Keep secrets out of the guide and describe how access is granted instead. Mark steps I did not describe [ADD]. Let the newcomer record what confused them and submit a pull request that improves the guide.
Fill in before use
Optional: type your details and the prompt above updates. Nothing is saved or sent.
Replace each bracketed placeholder with your own details, then paste into Any AI or another assistant.