...

How to write an Issue or Epic Ref

High-level rules

• Every commit Either the PR body or each commit message should have at least one Issue ref or Epic ref.

  1. If all commits relate to all Issue or Epic Ref(s), the Issue or Epic Ref(s) can be put into the PR descriptionbody or in each commit.

  2. If different commits relate to different issues or epics, then either 1) the PR body can contain a primary reference and any commits that differ need their own reference or 2) each commit needs its own issue or epic references.

• Issue refs can reference either GitHub or Jira issues. Epic refs must point to Jira issues only.

• Issue or Epic Refs can go anywhere in the PR body or commit message, preferably before the Release Note.

• The most to least preferred reference types are:

  1. An issue ref where the issue contains an /wiki/spaces/JIRA/pages/1925283849

  2. An issue ref to an issue without epic link and an epic ref

  3. An epic ref or issue ref without epic link

  4. An Epic: none ref

...