From 5d9d4d9f63b26aaae9e825e3fe03482bb91543f8 Mon Sep 17 00:00:00 2001 From: Cris Lom <36197748+Lombardoc4@users.noreply.github.com> Date: Sat, 10 Feb 2024 22:51:39 -0500 Subject: [PATCH] docs: FRON-4 jira smart commits (#22) --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 1dbf7ab..3dfa599 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,11 @@ This project is using [conventional commits](https://www.conventionalcommits.org - `Squash and merge` can be used when the commits _**DON'T**_ need to be individually brought in to the target branch. - [More information](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github). +- **Jira issue linking** + - Commits and PRs **_must_** be linked to a Jira issue. + - To do so, include the Jira issue key in the PR title and/or the commit message after the conventional commit type. + - [More information on Jira smart commits](https://support.atlassian.com/jira-software-cloud/docs/process-issues-with-smart-commits/). + ## Tests // TODO [cypress](https://www.cypress.io/)