Sets up the engineering baseline for El Foundation before product work begins. - README.md: project overview and repo layout - CONTRIBUTING.md: branch naming, PR process, commit style, definition of done - docs/engineering/tech-stack.md: frontend, backend, and tooling choices with rationale - docs/engineering/onboarding.md: 30-day onboarding checklist - docs/adrs/adr-template.md: decision record template - .github/workflows/ci.yml: markdown lint + placeholder for TypeScript checks - docs/engineering/first-engineer-role.md: scope, skills, 30-day priorities, hire recommendation Co-Authored-By: Paperclip <noreply@paperclip.ing>
44 lines
1.4 KiB
Markdown
44 lines
1.4 KiB
Markdown
# Engineer Onboarding
|
||
|
||
## Before Day 1
|
||
|
||
- [ ] Access to GitHub org granted
|
||
- [ ] Access to Paperclip workspace granted
|
||
- [ ] Added to project channels / async standup
|
||
|
||
## Day 1: Context
|
||
|
||
- [ ] Read the [company charter](../company/charter.md)
|
||
- [ ] Read the [operating model](../company/operating-model.md)
|
||
- [ ] Read [ways of working](../company/ways-of-working.md)
|
||
- [ ] Read [how we decide](../company/how-we-decide.md)
|
||
- [ ] Read [CONTRIBUTING.md](../../CONTRIBUTING.md)
|
||
- [ ] Read [tech-stack.md](tech-stack.md)
|
||
- [ ] Introduce yourself in the team channel (async written standup format)
|
||
|
||
## Day 2–3: Environment
|
||
|
||
- [ ] Clone the repo
|
||
- [ ] Install dependencies (`pnpm install` when package.json exists)
|
||
- [ ] Run the dev server locally
|
||
- [ ] Verify you can run tests
|
||
- [ ] Verify you can run lint
|
||
- [ ] Open your first PR (a README typo fix or doc improvement counts)
|
||
|
||
## Week 1: First Task
|
||
|
||
- [ ] Pick up a `good first issue` or grab a task from the backlog with CTO approval
|
||
- [ ] Follow the full task lifecycle: branch → PR → review → merge
|
||
- [ ] Shadow one code review as a reviewer (even if just observing)
|
||
|
||
## First 30 Days
|
||
|
||
- [ ] Ship at least one meaningful change to production (or equivalent if pre-launch)
|
||
- [ ] Write or update one piece of documentation
|
||
- [ ] Attend (async) one decision review or ADR discussion
|
||
- [ ] Provide feedback on the onboarding process itself
|
||
|
||
## Questions?
|
||
|
||
Ask the CTO or post in the project channel. Async-first: write it down.
|