# NonaTemplate :: Contributing

## Naming conventions

### GIT Branch Names

Combine the Jira ticket id and a shortened version of the ticket title and underscore it all:

`<JIRA_TICKET_ID>_<SHORTENED-JIRA-TICKET-NAME>`

So if the Jira ticket is:

`NonaTemplate-714: MOB: refactor updateUserUsernameEpic to catch errors thrown by util`

then the branch should be named:

`NonaTemplate-714_catch-util-errors-in-updateUserUsernameEpic`

shortest possible version that still describes the ticket.

### GIT Story Branch Names

If the Jira ticket is:

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

then the branch should be named:

`NonaTemplate-700_user-can-see-things-on-home`

shortest possible version that still describes the ticket.

### GIT Commit Messages

We are using [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0-beta.4/).

please read through the guide at the above link and make sure that you are adhering to the standard outlined above.

[commitlint](https://commitlint.js.org/#/) 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