Skip to content

Standards

Alex Glen edited this page Jan 22, 2024 · 12 revisions

Branch Standards:

When you are naming branches you need to start them with the corresponding area you are working on. (e.g. dev, FE/, BE/, API/***) For example; API/first-epic-commit

Commit Standards:

We are going to be following, the conventional commits (https://www.conventionalcommits.org/en/v1.0.0-beta.2/), check the link for a full summary.

For example:
COMMIT CONVENTIONS: fix:, docs:, feat:, etc.

E.g. fix: added a button

PR Standards:

When sending a pull request you need to have the issue number within the PR. You MUST put the issue request number within the PR description, otherwise the YAML file will reject the PR.

Issue Standards:

When creating issues we can use the "Issue Template" then we want to add a step-by-step guide. We then link any relevant issues that relate to issue/user story.

Clone this wiki locally