Skip to main content

commit-convention

Conventional commit message format and rules for this project

Source facts

Repository
spiriMirror/libuipc
Last source activity
March 6, 2026 at 07:13
Detected SKILL.md language
English
Stars
335
Forks
68

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

Showing SKILL.md

SKILL.md
Source instructions · Read-only preview
name
commit-convention
description
Conventional commit message format and rules for this project
# Commit Convention Use [Conventional Commits](https://www.conventionalcommits.org/) format: ``` <type>(<scope>): <short summary> ``` ## Types | Type | When to Use | |---|---| | `feat` | New feature | | `fix` | Bug fix | | `refactor` | Code restructuring (no behavior change) | | `perf` | Performance improvement | | `test` | Adding or updating tests | | `docs` | Documentation only | | `build` | Build system or dependency changes | | `ci` | CI/CD changes | | `chore` | Other maintenance tasks | ## Examples ``` feat(geometry): add label_open_edge utility fix(cuda): resolve race condition in contact solver refactor(core): simplify scene validation logic test(sim_case): add ABD-FEM contact test docs: update build instructions ``` ## Rules - **Scope** is optional but encouraged — use the module name (e.g., `geometry`, `core`, `cuda`, `io`). - **Summary** should be lowercase, imperative mood, no period at the end. - Add a blank line then a body for longer explanations if needed. - Reference issues with `Fixes #<number>` or `Closes #<number>` in the body.
View on GitHub