Project Notation

Issue Naming Convention

[BP] - Build Process improvements (CI/CD Change)

[NF] - New Functionality

[CR] - Change Request

[RF] - Refactoring

[CI] - Critical Issue

[BF] - Bug Fix

[DC] - Documentation Change

[AD] - Architecture Description Records [1] [2]

[REF-{number}] - Depends on implementation from the ticket {number}

<Issue Type>-<Issue Number>

Sample:

NF-2

[#<Issue Number>] <Issue Name>. <Summary>

<Description of Change>

Sample:

[#2] [NF] Create main window. Update color schema definition

Make palette responsive to the system configuration

Recommended a format in present tense by using active voice with an initial word as:

Add: Create a capability e.g. feature, test, dependency.
Drop: Delete a capability e.g. feature, test, dependency.
Fix: Fix an issue e.g. bug, typo, accident, misstatement.
Bump: Increase the version of something e.g. a dependency.
Make: Change the build process, or tools, or infrastructure.
Start: Begin doing something; e.g. enable a toggle, feature flag, etc.
Stop: End doing something; e.g. disable a toggle, feature flag, etc.
Optimize: A change that MUST be just about performance, e.g. speed up code.
Document: A change that MUST be only in the documentation, e.g. help files.
Refactor: A change that MUST be just a refactoring patch
Reformat: A change that MUST be just a formatting path, e.g. change spaces.
Rearrange: A change that MUST be just an arranging patch, e.g. change layout.
Redraw: A change that MUST be just a drawing patch, e.g. change a graphic, image, icon, etc.
Reword: A change that MUST be just a wording patch, e.g. change a comment, label, doc, etc.
Revise: A change that MUST be just a revising patch e.g. a change, an alteration, a correction, etc.
Refit/Refresh/Renew/Reload: A change that MUST be just a patch e.g. update test data, API keys, etc.