Contributing Guidelines

Creating or Updating Handbook

  • Always use coding-guidelines.md when creating a new Handbook Guideline
  • Every PR must have at least one reviewer before merging

Creating a New Guideline

  1. Clone this repository
  2. Create the appropriate folder inside /guidelines if it doesn't exist
  3. Copy ./format/coding-guidelines.md into the folder and rename it
  4. Fill in the content and raise a PR

Updating an Existing Guideline

  1. Clone the latest version of the repository
  2. Make your changes
  3. Update the Changelog table inside the document

Versioning Rules

Change Type What to Do
New rule or major content change Bump version 1.0.0 → 1.1.0 + add changelog entry
Typo, spacing, or formatting fix Add changelog entry only — no version bump

Reviewer Policy

  • Minimum 1 reviewer required on every PR
  • For changes that affect existing rules, reviewer must be a Tech Lead or document owner