Engineering Onboarding: [team / project]
New-engineer onboarding – setup to first PR
Як використовувати: One per team. If setup takes over an hour, the guide is buggy – treat it like code.
Перегляд
Engineering Onboarding: [team / project]
The day-one to first-PR path for a new engineer. Write for someone who has never seen this codebase or this organization.
Before day 1 (manager)
- Accounts: repo, CI, chat, issue tracker, cloud console
- Hardware and dev machine shipped
- Buddy assigned: @name
- First task picked – scope: half a day, real but safe
Week 1 checklist
- Machine setup complete (below)
- Repo cloned, app running locally, tests green
- Architecture walkthrough with @name
- First PR merged – a docs fix counts
- Met everyone in People
Environment setup
- Install prerequisites: [tool versions]
- Clone:
git clone [repo-url] - Configure secrets: [where dev secrets live – never commit them]
- Run:
[command], then open[local url] - Verify:
[command]should print OK
If setup takes over an hour, that is a bug in this guide – fix it.
Architecture in one page
flowchart LR
Client --> API[API service]
API --> DB[(Database)]
API --> Q[(Queue)] --> W[Worker]
- Key modules:
[dir]does [what];[dir]does [what] - Review conventions: [link or summary]
- Release process: [how code reaches production]
People
| Role | Who | Ask them about |
|---|---|---|
| Buddy | @name | Daily questions |
| Team lead | @name | Priorities, process |
| Domain expert | @name | [subsystem] |
30 / 60 / 90
| Milestone | Expectation |
|---|---|
| 30 days | Ships small fixes independently |
| 60 days | Owns a medium feature end-to-end |
| 90 days | On-call ready; reviews others' PRs |