<aside> 💡 What is this document? We have certain ways of naming branches, repos and more, this document explains the conventions we expect every developer to follow.

</aside>

<aside> 👓 Who is it for? Developers.

</aside>

• Contents

Branches

<aside> 📋 Jira projects Jira projects must use@we-make-websites/branch-naming-check version 2.0.3 or newer in package.json, **this package enforces the new branch naming convention.

</aside>

The following rules are enforced automatically using Husky in Frame 3, Basis Adapter, and Canvas. Your commit will be rejected if it doesn’t meet guidelines, see the terminal if your commit fails for reasons why.

When creating a branch for a new task the following naming convention should be followed:

[prefix]/[key-id]-[taskName]

<aside> ⚠️ Please follow the naming convention! Doing so will reduce confusion when searching for branches. When creating the branch in Jira it will suggest a branch name, you must rename this otherwise when it comes time to commit the branch name will be rejected.

</aside>

Prefix

• bugfix - Branch to fix client bug reported by bug form
• feature - Any new feature on active projects or OS clients
• hotfix - Urgent fixes
• release - A deployment release

Key-ID