Skip to content

Latest commit

 

History

History
28 lines (17 loc) · 947 Bytes

contributing.md

File metadata and controls

28 lines (17 loc) · 947 Bytes

System Design Dashboard Vue App :: Contributing

Naming conventions

GIT Branch Names

If the ticket is:

JX-700: As a user I should see my things listed on the home page

then the branch should be named:

JX-700_user-can-see-things-on-home

shortest possible version that still describes the ticket.

GIT Commit Messages

We are using conventional commit messages. please read through the guide at the above link and make sure that you are adhering to the standard outlined above. commitlint is used to enforce this standard via a husky hook, so if you do not structure your commit message using the format mentioned above, it will fail.

Branches, PRs & Merging

  1. Branch your task branch from develop
  2. Create a Pull Request onto the develop
  3. Request a Peer Review
  4. Once approved, squash merge into develop