Developer Onboarding · Example edition
Reach a working example before changing the system.
This fictional guide introduces a static handover-template repository. Commands describe the example workflow and should be replaced with the actual project’s verified setup instructions.
| Step | Purpose | Completion check |
|---|---|---|
| Read the working agreement | Understand scope and workflow | Branch and review rules are clear |
| Inspect a template | Learn the source structure | HTML, metadata, and brief located |
| Build locally | Produce a portable artifact | Example page opens correctly |
| Make a small change | Practice the contribution path | Diff is focused and checked |
| Request review | Share evidence and limits | Reviewer can reproduce the result |
A useful repository map
Start with the README, contributor agreement, template catalog, shared styles, and build script. Identify which files are canonical and which are generated before editing either.
First contribution
Improve one unclear label or a small content example. Build the artifact, check desktop and mobile output, and explain the user-visible change in the review description.
When setup fails
Record the command, expected result, actual error, and relevant runtime version. Keep secrets out of logs and ask the responsible maintainer about missing access rather than inventing configuration values.