commits

name	commits
description	Commit message and branch naming conventions. Use when writing commit messages, naming branches, or squashing changes before a pull request.
license	Proprietary. See LICENSE for complete terms.
metadata	{"author":"kNoAPP","version":"1.2.0"}

Commit Conventions

This project uses Conventional Commits.

Format

<type>(<scope>): <short description>

[optional body]

[optional footer]

Types

Type	When to use
feat	New feature or capability
fix	Bug fix
docs	Documentation only
style	Formatting-only code changes
refactor	Code change with no behavior change
perf	Performance improvement
test	Adding or updating tests
build	Build system or external deps
ci	CI/CD workflow changes
chore	Dependency updates, tooling, config
revert	Revert previous changes

Breaking changes append ! to the type: feat!: drop support for v1 frames.

Rules

• Subject line must use imperative mood and start lowercase: add wifi reconnect, not Added WiFi Reconnect.
• Keep the subject under 72 characters.
• Scope is optional but helpful for the protocol layer: fix(parser): handle malformed BLE frames.
• PR titles follow the same format — CI will reject non-conforming titles.

Branch Naming

Per CONTRIBUTING.md, branches follow:

<handle>/<issue#>-<type>-<short-description>

<handle> is your GitHub handle. When there is no linked issue, use none for <issue#>. Types match the commit types above (feat, fix, docs, refactor, test, ci, chore).

Examples: kNoAPP/41-feat-wifi-reconnect, mario/none-chore-modify-eslint, docs/readme-update