Skip to content

Contribution & Review Process

Status: 🟢 Active  |  Owner: Architecture Team

How to Contribute

All content is stored in the internal/engineering-standards GitHub repository. Contributions follow standard pull request workflow.

Steps

  1. Fork or branch from main using the naming convention standards/<short-description>.
  2. Edit or create the relevant Markdown file under docs/.
  3. Follow the page template: include the status badge, owner, overview, standards section, and references.
  4. Run locally: mkdocs serve to verify rendering.
  5. Open a PR using the Standards PR template. Tag the relevant guild or team owner.
  6. Minimum review: 2 approvals required — at least one from the page owner's team.
  7. EAB approval required for any change that promotes a page from Draft → Active or Active → Deprecated.

Page Template

# Page Title

**Status:** 🟢 Active &nbsp;|&nbsp; **Owner:** Team Name

Brief one-paragraph description of what this page covers.

## Overview

Context and rationale.

## Standards

The actual standards — use admonitions, tables, and code blocks as appropriate.

## References

- [External link](https://...)
- Related internal page

---
*Last reviewed: YYYY-QN &nbsp;|&nbsp; Owner: Team Name*

Commit Message Convention

Follow Conventional Commits:

docs(security): add OWASP Top 10 remediation guidance
docs(java): update Spring Boot standard to 3.2
fix(tooling): correct broken link in vscode page

Last reviewed: 2025-Q4  |  Owner: Architecture Team