🪃
Engineering Playbook
  • Engineering Playbook
  • Agile Development
    • Kanban from the start
    • Daily Stand-up
    • Collaboration
      • Mobile Designer X Mobile Developer
    • Backlog Management
      • Backlog Refinement
    • Card Management
      • Epics
      • User story
        • Collaboration experience with acceptance criteria
        • Proper acceptance criteria
      • Task
      • Bug
      • Hotfix
      • Sub-task
      • Defect
      • Columns
      • Card organization
      • Column Limit
      • Board Templates
    • Pull System Task Assignment
    • Retrospectives
    • Team Agreement
      • Working Agreement
      • Definition of Ready
      • Definition of Done
    • Agile Metrics
  • Github
    • Source Control
    • Merge Strategies
    • Versioning
    • Code Reviews
      • Author's Checklist
      • Reviewer's Checklist
  • Documentation
    • GraphQL as an API Doc
  • DevOps
    • Continuous Integration
Powered by GitBook
On this page
  • Branch Policies
  • Rebase topic branch before Squash merge into main
  • Naming Branches
  • Branching Model
  • Commit Message

Was this helpful?

  1. Github

Merge Strategies

Branch Policies

Configure protected branches at Git

Rebase topic branch before Squash merge into main

Advantage of Squash and Merge

Follow the code standards

Peer code reviews

Naming Branches

Look for CONTRIBUTING.md

feature/* fix/*

Branching Model

Trunk-based development

Short-lived branches

Make use of Squash and Merge

Commit Message

Follow this format:

[type]([optional scope]): [short summary]
  │       │             │
  │       │             └─⫸ Summary in present tense and imperative form. Not capitalized. No period at the end.
  │       │
  │       └─⫸ Commit Scope: bounded changes like. For example:
  │                          api | bazel | server | projection | framework
  │
  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test

[optional body]

[optional footer]

Example:

feat(api): add basic member's CRUD API

It includes a generic create, fetch all, update one and delete one endpoint for member.

closes JAM-12
feat: make lastname required

BREAKING CHANGE: `lastname` would required during create/register of an account.
PreviousSource ControlNextVersioning

Last updated 3 years ago

Was this helpful?