DevOps Playbook

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)

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 examples

• feature/user-login
• fix/cart-total-bug
• refactor/payment-service
• chore/update-dependencies
• docs/api-setup-guide
• test/add-auth-tests

Issue title examples

• Feature Request

  • Add dark mode support
  • Implement user profile page
  • Create order export feature
  • Support multi-language UI
  • Add email notifications

• Bug Report

  • Fix login redirect issue
  • Resolve checkout page crash
  • Fix incorrect order total
  • Button not clickable on mobile
  • API returns 500 error

• Refactoring

  • Fix login redirect issue
  • Resolve checkout page crash
  • Fix incorrect order total
  • Button not clickable on mobile
  • API returns 500 error

• Documentation

  • Update installation guide
  • Add API usage examples
  • Fix README formatting
  • Document environment variables

• DevOps / CICD

  • Add staging deployment pipeline
  • Fix Docker build failure
  • Update GitHub Actions workflow
  • Configure application logging

Pull request Title

format: [Action] [what changed]

• Add user authentication flow
• Fix checkout calculation bug
• Simplify order validation logic
• Clean up unused components
• Improve README examples