STDF Commit Style
Core Rule
Use the STDF repository commit style when committing in this project:
[scope]English commit subject
Keep the subject as one line. Use English for the commit subject. Do not add a commit body unless the user asks for details or the change is unusually risky.
Scope Selection
Choose the narrowest scope from the changed files:
[stdf]: packages/stdf component library source, component types, theme, language files, package release changes.[demo]: packages/stdf/src/routes demo pages, example startup commands, demo-only behavior.[doc]: docs, readme, README, guide text, component documentation, changelog text.[create]: packages/create scaffolding CLI, templates, create package releases.[vscode]: packages/vscode-extension extension code, assets, changelog, extension release changes.[ci]: .github, workflow, release automation, deployment automation.[site]: documentation site release-only commits.[icon]: icon plugin package or icon-specific documentation.[md]: markdown plugin package or markdown-plugin-only documentation.
If one commit changes unrelated scopes, split it. If a small support file change clearly belongs to a feature, keep it with that feature's scope. If no scope is clear, use a plain English subject such as Update README file.
Wording
Use short English action phrases:
Fix ...Add ...Update ...Optimize ...Remove ...Release ...Document ...Change ...Improve ...Enhance ...
Use release wording like:
[stdf]Release 2.0.1
[create]Release 0.3.0
[vscode]Release 1.2.0
Use fix wording like:
[stdf]Fix Input component
[demo]Fix demo theme sync in docs site
[doc]Fix NoticeBar version docs
Use update wording like:
[doc]Update component docs
[ci]Update STDF release workflow
[create]Update create-stdf to 0.2.11
Formatting Details
- Prefer ASCII square brackets:
[doc], not 【doc】.
- Do not put a space between
] and the English subject.
- Keep English words and numbers separated by spaces inside the subject, for example
Release 2.0.1 and Update STDF files.
- Do not use
feat:, fix:, or chore: for normal local commits in this repo.
- Do not mention implementation trivia unless it is the user-facing change.
- Avoid overly long subjects. If the change has several independent effects, split commits instead of writing a long combined subject.
Commit Workflow
- Inspect
git status --short and the relevant diffs.
- Preserve unrelated user changes. Do not stage files outside the chosen commit group.
- Group changes by scope and behavior.
- Generate one STDF-style subject per group.
- Run the relevant verification command before committing when practical. Use
bun for package commands.
- Stage only the intended files and commit with the generated one-line subject.
Examples By Change
- Component bug fix in
packages/stdf/src/lib/components/timePicker: [stdf]Fix TimePicker date column reactive loop
- Demo route adjustment in
packages/stdf/src/routes/timePicker: [demo]Optimize TimePicker demo
- Documentation text update in
docs/mds/components/timePicker: [doc]Update TimePicker docs
- Create template update in
packages/create/templates: [create]Update create-stdf template
- GitHub Actions change:
[ci]Update release workflow
Source: any-tdf/stdf — distributed by TomeVault.
1---2name: stdf-commit-style3description: Use when creating, planning, or reviewing git commits in the STDF repository. Follow the repository's scoped commit history style with English subjects like [stdf]Fix Input component, split unrelated changes, and avoid generic Conventional Commits unless preserving external contributor commits.4---56# STDF Commit Style78## Core Rule910Use the STDF repository commit style when committing in this project:1112```text13[scope]English commit subject14```1516Keep the subject as one line. Use English for the commit subject. Do not add a commit body unless the user asks for details or the change is unusually risky.1718## Scope Selection1920Choose the narrowest scope from the changed files:2122- `[stdf]`: `packages/stdf` component library source, component types, theme, language files, package release changes.23- `[demo]`: `packages/stdf/src/routes` demo pages, example startup commands, demo-only behavior.24- `[doc]`: `docs`, `readme`, `README`, guide text, component documentation, changelog text.25- `[create]`: `packages/create` scaffolding CLI, templates, create package releases.26- `[vscode]`: `packages/vscode-extension` extension code, assets, changelog, extension release changes.27- `[ci]`: `.github`, workflow, release automation, deployment automation.28- `[site]`: documentation site release-only commits.29- `[icon]`: icon plugin package or icon-specific documentation.30- `[md]`: markdown plugin package or markdown-plugin-only documentation.3132If one commit changes unrelated scopes, split it. If a small support file change clearly belongs to a feature, keep it with that feature's scope. If no scope is clear, use a plain English subject such as `Update README file`.3334## Wording3536Use short English action phrases:3738- `Fix ...`39- `Add ...`40- `Update ...`41- `Optimize ...`42- `Remove ...`43- `Release ...`44- `Document ...`45- `Change ...`46- `Improve ...`47- `Enhance ...`4849Use release wording like:5051```text52[stdf]Release 2.0.153[create]Release 0.3.054[vscode]Release 1.2.055```5657Use fix wording like:5859```text60[stdf]Fix Input component61[demo]Fix demo theme sync in docs site62[doc]Fix NoticeBar version docs63```6465Use update wording like:6667```text68[doc]Update component docs69[ci]Update STDF release workflow70[create]Update create-stdf to 0.2.1171```7273## Formatting Details7475- Prefer ASCII square brackets: `[doc]`, not `【doc】`.76- Do not put a space between `]` and the English subject.77- Keep English words and numbers separated by spaces inside the subject, for example `Release 2.0.1` and `Update STDF files`.78- Do not use `feat:`, `fix:`, or `chore:` for normal local commits in this repo.79- Do not mention implementation trivia unless it is the user-facing change.80- Avoid overly long subjects. If the change has several independent effects, split commits instead of writing a long combined subject.8182## Commit Workflow83841. Inspect `git status --short` and the relevant diffs.852. Preserve unrelated user changes. Do not stage files outside the chosen commit group.863. Group changes by scope and behavior.874. Generate one STDF-style subject per group.885. Run the relevant verification command before committing when practical. Use `bun` for package commands.896. Stage only the intended files and commit with the generated one-line subject.9091## Examples By Change9293- Component bug fix in `packages/stdf/src/lib/components/timePicker`: `[stdf]Fix TimePicker date column reactive loop`94- Demo route adjustment in `packages/stdf/src/routes/timePicker`: `[demo]Optimize TimePicker demo`95- Documentation text update in `docs/mds/components/timePicker`: `[doc]Update TimePicker docs`96- Create template update in `packages/create/templates`: `[create]Update create-stdf template`97- GitHub Actions change: `[ci]Update release workflow`9899---100> Source: [any-tdf/stdf](https://github.com/any-tdf/stdf) — distributed by [TomeVault](https://tomevault.io).101<!-- tomevault:4.0:skill_md:2026-06-18 -->
tomevault-io