mirror of
https://github.com/bitsocialnet/5chan.git
synced 2026-08-03 07:41:04 +02:00
Tommaso CasaburiandGitHub
a92b185a66
* chore(ai-workflow): track repo-managed review tooling * fix(ai-workflow): remove repo-specific path assumptions Make shared workflow hooks and APK testing guidance resolve paths from the repo and contributor environment so the tooling works for all contributors, not just one machine.
56 lines
1.8 KiB
Markdown
56 lines
1.8 KiB
Markdown
---
|
|
name: commit-format
|
|
description: Formats GitHub commit messages following Conventional Commits style with title and optional description. Use when proposing or implementing code changes, writing commit messages, or when the user asks for commit message suggestions.
|
|
---
|
|
|
|
# Commit Format
|
|
|
|
## Template (copy this structure exactly)
|
|
|
|
Title only — raw markdown:
|
|
```
|
|
> **Commit title:** `type: short description here`
|
|
```
|
|
|
|
Title with description — raw markdown:
|
|
```
|
|
> **Commit title:** `type: short description here`
|
|
>
|
|
> Description sentence one. Description sentence two with `codeRef()` references.
|
|
```
|
|
|
|
## Rules
|
|
|
|
1. Use markdown blockquote (`>` prefix) — no exceptions
|
|
2. Title goes after `**Commit title:**` wrapped in exactly ONE backtick pair
|
|
3. NEVER put backticks inside the title — the whole title is one code span, no nesting
|
|
4. Description uses backticks for code references — title does NOT
|
|
5. Conventional Commits types: `fix:`, `feat:`, `perf:`, `refactor:`, `docs:`, `chore:`
|
|
6. Use `perf:` for performance optimizations (not `fix:`)
|
|
7. Description: 2-3 sentences about the solution, no bullet points, only if title isn't enough
|
|
|
|
## Wrong vs Right
|
|
|
|
❌ WRONG — missing backticks around title:
|
|
```
|
|
> **Commit title:** refactor: rename from /queue to /modqueue
|
|
```
|
|
|
|
❌ WRONG — backticks around individual words instead of whole title:
|
|
```
|
|
> **Commit title:** refactor: rename from `/queue` to `/modqueue`
|
|
```
|
|
|
|
✅ CORRECT — entire title in one backtick pair, no backticks inside:
|
|
```
|
|
> **Commit title:** `refactor: rename from /queue to /modqueue`
|
|
```
|
|
|
|
## Self-check
|
|
|
|
Before outputting, verify:
|
|
- [ ] Lines start with `>`
|
|
- [ ] Title is wrapped in exactly one backtick pair: `` `like this` ``
|
|
- [ ] No backticks inside the title text
|
|
- [ ] Code references in description (not title) use backticks
|