Instruction file imported from isaacismaelx14/minerelay (.github/instructions/commit.instructions.md). Copyright stays with the author.

Commit Message Instructions

Name: commit
Author: isaacismaelx14

These instructions are mandatory for AI-generated commits in this repository.

Required Title Format

Use exactly:

type(scope): short summary

Optional breaking format:

type(scope)!: short summary

Rules:

type must be lowercase
scope is mandatory
summary should be concise, imperative, and without trailing period

Allowed Types

Only these are allowed:

feat
fix
perf
refactor
docs
style
chore
build
ci
test

Allowed Scopes

Only these are allowed:

api
admin
launcher
platform
desktop
shared
core
ui
release

Do not use any other scope.

Breaking Changes

When introducing breaking behavior:

Use ! in title
Include body line: BREAKING CHANGE: <what changed and migration guidance>

Multi-change Commit Bodies

When needed, body bullet lines must also be conventional:

* feat(api): ...
* fix(shared): ...

Examples

Valid:

ci(platform): update semantic release workflow inputs
feat(api): expose package version at root endpoint
fix(launcher): show app version in compact header
chore(release): @minerelay/api/v0.1.0-beta.32

Invalid:

feat: add release flow (missing scope)
feat(unknown): add release flow (scope not allowed)
Update workflow (not conventional)

Enforcement

Husky commit-msg validates these rules from release.config.json. If commit is rejected, rewrite it to match this file.

{ "ocm": "1", "id": "isaacismaelx14-minerelay-commit-instructions", "kind": "skill", "name": "commit", "description": "Load these instructions whenever the task involves writing, editing, or suggesting git commit messages for this repository.", "publisher": "isaacismaelx14", "version": "1.0.0", "capabilities": { "domains": [ "coding" ], "tags": [ "skill-md", "github-instructions" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "Load these instructions whenever the task involves writing, editing, or suggesting git commit messages for this repository." ], "primary": false, "metadata": { "source": { "provider": "github-instructions", "repository": "https://github.com/isaacismaelx14/minerelay", "path": ".github/instructions/commit.instructions.md", "ref": "b35faa045bcfdf515e31e87db6348b736791333c", "url": "https://github.com/isaacismaelx14/minerelay/blob/b35faa045bcfdf515e31e87db6348b736791333c/.github/instructions/commit.instructions.md", "key": "isaacismaelx14/minerelay/.github/instructions/commit.instructions.md" } }, "instructions": "# Commit Message Instructions\n\nThese instructions are mandatory for AI-generated commits in this repository.\n\n## Required Title Format\n\nUse exactly:\n\n`type(scope): short summary`\n\nOptional breaking format:\n\n`type(scope)!: short summary`\n\nRules:\n\n- `type` must be lowercase\n- `scope` is mandatory\n- summary should be concise, imperative, and without trailing period\n\n## Allowed Types\n\nOnly these are allowed:\n\n- `feat`\n- `fix`\n- `perf`\n- `refactor`\n- `docs`\n- `style`\n- `chore`\n- `build`\n- `ci`\n- `test`\n\n## Allowed Scopes\n\nOnly these are allowed:\n\n- `api`\n- `admin`\n- `launcher`\n- `platform`\n- `deskt", "cost": { "context_tokens": 373 } }

commit

About

Commit Message Instructions

Required Title Format

Allowed Types

Allowed Scopes

Breaking Changes

Multi-change Commit Bodies

Examples

Enforcement

Use it

Manifest

Reviews