Skip to content

Development

BC Ko edited this page Jul 4, 2023 · 7 revisions

Coding Style

Commit Messages

Git Branch Naming Convention

  • <category>-<issue id>-<brief name>-<part #>
  • feature-4-event-processing-01

Category

  • feature: new feature
  • bug : Code changes linked to a known issue
  • refactor: Code refactoring
  • experiment: Any new feature or idea that is not part of a release or a sprint. A branch for playing around.
  • chore: for everything else (writing documentation, formatting, adding tests, cleaning useless code etc.)

Issue ID

Each Github issue has its associated id (ex. 1, 2, 3)

Clone this wiki locally