Fix a factual error
Open an issue with the guide URL, the claim that needs correction, a supporting reference, and the suggested change.
Better engineering knowledge is shared knowledge.
The handbook should get better as more engineers challenge assumptions, improve explanations, and contribute real-world perspective.
What makes a great contribution?
A clear problem, a precise explanation, a reproducible example, a useful diagram, an authoritative source, or a correction that makes the guide more accurate.
Ways to contribute
Improve an existing guide
Prefer focused pull requests. Explain the problem being solved, provide sources for technical claims, and test any code examples you add.
Propose a new field guide
Start with a concrete engineering situation and the learning outcome. Avoid generic topic overviews that duplicate official documentation without adding explanation.
Add an interactive exercise
Make it keyboard accessible, give explanatory feedback for every option, avoid requiring secrets or paid APIs, and make the limits of a simulated scenario clear.
Editorial standards
- Use original wording and cite the sources that support technical claims.
- Do not fabricate company incidents, metrics, quotations, benchmarks, or personal experience.
- Label hypothetical scenarios as hypothetical and distinguish recommendations from requirements.
- Keep examples minimal, runnable, and safe by default.
- Include dates for tool-specific instructions and revisit them when behaviour changes.
- Never publish credentials, internal code, private user data, or confidential employer information.
START SMALL
Review the current guides Found a gap? That is a good first contribution.
The project is intended to use a public Git repository and ordinary pull requests. Add the repository URL and issue links here once the project is published.