Skip to main content

Git

Issue and Branch Relationship​

  • All work must be started with an issue
  • All work must be done in a branch
  • All branches must be named with the following format: <type>/<issue id><name>

Commit Message​

Format​

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Example​

feat: allow overriding of webpack config (#28)

* feat: allow overriding of webpack config

* fix: use correct env variable

Type​

Must be one of the following:

  • feat: A new feature

  • fix: A bug fix

  • docs: Documentation only changes

  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)

  • refactor: A code change that neither fixes a bug nor adds a feature

  • perf: A code change that improves performance

  • test: Adding missing or correcting existing tests

  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

  • Conventional Commits