菜单
Generates correctly formatted commit messages and pull request descriptions for this repository. Uses Conventional Commits / semantic-release format with issue references. Use this skill whenever writing, reviewing, or amending a commit message or drafting a PR title and body.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Lints shell scripts and Markdown files in the bash-logger repository using the project's configured toolchain. Use this skill whenever checking code quality, fixing linting errors, or running lint as part of a pre-commit or pre-PR workflow.
Runs the full gate sequence before raising a pull request on bash-logger. Covers linting, targeted tests, full test suite, code review checklist, commit message audit, PR description requirements, and branch hygiene. Use this skill before pushing to a shared branch or opening a PR.
Runs the bash-logger test suite — either the full suite or a targeted subset. Use this skill whenever running, selecting, or interpreting tests in this repository. Covers discovering available suites, choosing which to run after a change, correct invocation syntax, and reading test output.
Reviews code changes in bash-logger for security issues across all protected domains. Use this skill whenever adding new features that handle external input, changing sanitization behaviour, adding config options, or reviewing a PR for security. Covers input sanitization, file system safety, config injection, environment variable attacks, journal command validation, sensitive data handling, and unsafe flag governance.
Adds new tests to the bash-logger test suite. Covers creating new test suites, adding tests to existing suites, correct use of assertions, isolation patterns, and the mandatory call registration pattern. Use this skill whenever writing, extending, or fixing tests in the tests/ directory.
| name | writing-commits |
| description | Generates correctly formatted commit messages and pull request descriptions for this repository. Uses Conventional Commits / semantic-release format with issue references. Use this skill whenever writing, reviewing, or amending a commit message or drafting a PR title and body. |
<type>(<scope>): <subject>
<body>
<footer>
Commit history drives automated versioning via semantic-release. Incorrect format means wrong or missing version bumps and changelog entries.
| Type | Version bump | Use for |
|---|---|---|
feat | minor | New user-visible functionality |
fix | patch | Bug fixes |
perf | patch | Performance improvements |
revert | patch | Reverting a prior commit |
refactor | patch | Internal restructuring, no behaviour change |
docs | none | Documentation-only changes |
style | none | Whitespace/formatting, no logic change |
test | none | Adding or updating tests |
chore | none | Build, tooling, dependency changes |
ci | none | GitHub Actions or CI config changes |
A BREAKING CHANGE footer triggers a major bump regardless of type.
| Scope | Use for |
|---|---|
logging | Core logging.sh functions |
config | Configuration file handling |
install | install.sh and Makefile install targets |
tests | Test files or test infrastructure |
docs | Documentation files |
scripts | Utility or demo scripts |
ci | GitHub Actions workflows |
deps | Dependency / Dependabot changes |
Explain why, not just what. Wrap at 72 characters.
Always include when the commit addresses a tracked issue:
Fixes #123
Closes #456
Refs #789
Fixes / Closes — auto-closes the issue on mergeRefs — links without closingBreaking changes:
BREAKING CHANGE: <what broke and migration path>
feat(logging): add structured JSON output format
Adds --format json to init_logger. JSON output goes to the log file only;
console output keeps the human-readable format.
Closes #87
fix(install): prevent path traversal in custom prefix validation
validate_prefix now rejects paths containing '..' sequences.
Fixes #102
docs: add configuration guide for systemd and cron environments
test(logging): add regression test for empty message handling
Refs #95
feat(logging): replace level array with associative map
BREAKING CHANGE: LOG_LEVELS is now an associative array. Scripts that
reference LOG_LEVELS by numeric index must switch to name-based keys
(e.g. LOG_LEVELS[INFO] instead of LOG_LEVELS[1]).
Use <type>(<scope>): <subject> — same format as the primary commit. If the PR contains multiple commits of the same type, use the highest-impact one.
## Summary
One paragraph explaining what this PR does and why.
## Changes
* Notable change one
* Notable change two
## Testing
Commands run and manual steps taken to verify.
## Related issues
Fixes #NNN
Refs #NNN
Always include issue links in the body even when they also appear in individual commit footers.