Naming Conventions

Web Development Naming Conventions

Embedded Programming Naming Conventions

Database Naming Conventions

Commit Naming Conventions

The Conventional Commits specification is a lightweight convention for commit messages. It provides a clear set of rules that make commit history more readable and enable automated tooling. It also ties directly into Semantic Versioning (SemVer), helping determine whether a change is a patch, minor, or major release.

Refer to Conventional Commits methodology.

Commit Message Format

<type>[optional scope]: <description> (Related Commit #)

[optional body]

[optional footer(s)]

• type: the kind of change (e.g., fix, feat, docs, etc.)
• scope (optional): a contextual label in parentheses (e.g., feat(parser): ...)
• description: a short summary of the change
• body (optional): more details about the change
• footer(s) (optional): metadata such as BREAKING CHANGE or references

Key Types

• fix: patches a bug (correlates with PATCH in SemVer)
• feat: introduces a new feature (correlates with MINOR in SemVer)
• chore: any non functional changes in the code (ex: linting, formatting)
• docs: addition or modification of documentation
• refactor:
• test:
• BREAKING CHANGE: indicates an API-breaking change (correlates with MAJOR in SemVer)

Examples

• Simple feature:

feat: allow config object to extend other configs (#5, #9)

• Commit with Body and Issue Reference

fix: prevent racing of requests (#13)

Introduce request id and dismiss responses other than the latest request.
Refs: #123