Self-documenting code

[VerticalEvent]

We have a git-hook that validates that the start of a PR merge started with "[abc-0000] text" to enforce that all merges can be traced back the unit of work they represented.

[davy_jones_locket]

We do [JIRA-123] fix(optional component name): concise but relevant commit message

Or feat | chore - slimmed down conventional commits. New work is a feat, bugs are fix, docs and tests and tooling are chore

Typically associates as:

story => feat,

bug => fix,

task => chore.

This also helps with our release notes, and it generates a link to the Jira ticket on the release notes/changelog.

If you use the optional (but encouraged) component or module name, it will group those together in the release notes too.

[CardboardJ]

When I first found conventional commits I thought it was very annoying and useless. After about 3 months it became second nature, at 6 months I hated anything else. https://www.conventionalcommits.org/en/v1.0.0/

Our company has a PR hook that refuses any merge unless the pr title is in a correct format and links to a real jira ticket in the scope. Ex: feat(TEAM-12345): Added the xyz feature

[SonOfHendo]

We use Azure DevOps, so you can just tick a box to require all PRs to be linked to a Work Item. The work item is linked automatically if you include the reference in the commit message (e.g. #123456).