Skip to content

DevOps Playbook

Weixian edited this page May 28, 2026 · 5 revisions

Naming Conventions

Commit Message

we follow semantic commit messages examples:

  • feat: add shopping cart checkout
  • fix: resolve null pointer in user service
  • refactor: simplify inventory validation
  • docs: update setup instructions
  • test: add unit tests for auth module
  • chore: upgrade npm dependencies

Branch name

Issue Title

Pull request Title

Standards

  • 1 PR = 1 feature or bug fix
  • Commit and sync remote at least once a day or multiple times per day
  • always label issue: feature, bugfix, frontend, backend, module-name and etc
  • Always create release note for every production release (BA help on this)
  1. Agile Delivery
    1. Product Requirement Template
    2. Documenting Product Requirements
    3. Estimation & Sizing
  2. DevOps
    1. Gitlab Flow with Release Branches
    2. DevOps Pipelines
  3. Software Architecture Design
    1. Agent Engineering
    2. Logging
  4. Tech Stack
  5. Testing & Quality
  6. Observability & Operations

Clone this wiki locally