Repository navigation
docs(skills): update git-commit and narrow commit-message-storyteller 🤖🤖🤖 - #4869
burakkaygusuz wants to merge 5 commits into
Conversation
- Rewrite the description with user intent triggers and exclusions. Exclude requests for only a commit message, which the commit-message-storyteller skill covers. - Add the compatibility field. Limit allowed-tools to shell(git:*). - Remove git add -p. Quote glob pathspecs so that they match files in subdirectories. - Replace the heredoc with repeated -m options that work in all shells. - Fix the header template to <type>(<scope>): <summary>. - Read the repository commit rules first. State that only feat and fix come from Conventional Commits. - Add git add --resolved (Git 2.56), a staged file check, and a check after the commit. - Explain why --amend is incorrect after a hook fails. Note that hooks can be in the Git configuration. - Add a breaking change example with a scope and the trailer format. - Rewrite the text in ASD-STE100 Simplified Technical English. - Update the description in docs/README.skills.md.
- Remove the "commit this", "help me commit", and "generate a commit" triggers. These requests ask for a commit, and the git-commit skill makes the commit. - Tell the agent that this skill does not run git commit. - Add the build type. Change chore to other maintenance, as in @commitlint/config-conventional. - Change the chore(deps) example in the guide to build(deps). - Update the description in docs/README.skills.md.
- Add the text language to fenced code blocks (MD040). - Add blank lines around headings, fences, and lists (MD022, MD031, MD032). - Put the bare URL in angle brackets (MD034). - Align the table separator rows (MD060).
🚦 Submission status: 💬 Review in progressRisk tier: Why this tier
Automated checks
Review
Commands
Updated for |
🔒 PR Risk Scan ResultsScanned 3 changed file(s).
✅ No matching risk patterns were detected in changed files.
|
🔍 Vally Lint Results✅ All checks passed
Summary
Full linter output |
aaronpowell
left a comment
There was a problem hiding this comment.
Thanks, the git-commit fixes are real improvements. Dropping git add -p, quoting pathspecs after --, swapping the heredoc for repeated -m, and the --resolved step (confirmed in the 2.56 release notes) all fix things agents trip on, and the storyteller/git-commit split is cleaner. One small non-blocking nit: in the Message Format section, 'Write each footer as Token: value, e.g. Closes: #123' reads as though Closes #123 is wrong. Conventional Commits allows both forms, and commit-message-storyteller uses Closes #123, so it would help to say both separators are valid. LGTM.
- List Token #value next to Token: value, as Conventional Commits allows both separators. The commit-message-storyteller skill uses the Closes github#123 form. - Tell the agent that Git reads only the Token: value form as a trailer.
|
Thanks for your review @aaronpowell ! Fixed in 772e239: both separators are now listed, with a note that Git parses only the colon form as a trailer. |
aaronpowell
left a comment
There was a problem hiding this comment.
Thanks for the quick fix in 772e239; the footer clarification addresses the last comment. One remaining correctness issue in skills/git-commit/SKILL.md:81–86: when unrelated files are already staged, git add -- on just one does not unstage the others, so the later plain git commit still includes both, meaning that there is some inconsistencies in the instructions given to the agent.
git add does not remove files from the index, so a plain git commit included unrelated staged files. Run git reset on those files first. It also works in a repository with no commits.
Thanks for your review; Fixed in 54064299: step 3 now runs |
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.mainbranch for this pull request.Description
Updates the
git-commitskill and narrows thecommit-message-storytellerskill so that the two skills do not overlap. The earlier version told the agent to run commands that fail or that wait for input. The update follows the Agent Skills specification, Conventional Commits 1.0.0, and Git 2.56.Changelog
git-commitfixesgit add -p. The agent cannot answer the interactive prompts.git add -- '*.test.*'). Without quotes, the shell expands the glob and does not find the files in subdirectories.$(cat <<'EOF' ...)heredoc with repeated-moptions. The heredoc does not work in PowerShell.<type>[scope]:to<type>(<scope>):.allowed-toolsfromBashtoshell(git:*), the Copilot pattern for Git commands.git-commitupdatescommit-message-storyteller.compatibilityfield.CONTRIBUTING.md,git log) first. State that Conventional Commits defines onlyfeatandfix.git add --resolved(Git 2.56) for a commit after a merge conflict.--amendchanges the previous commit. Note that hooks can be in the Git configuration (Git 2.54).git historycommand.Token: valuetrailer format.commit-message-storytellergit-commitmakes the commit.git commit.buildtype. Changechoreto other maintenance, as in@commitlint/config-conventional.chore(deps)example inreferences/conventional-commits-guide.mdtobuild(deps).stylecommit.Generated files
docs/README.skills.md.Type of Contribution
Additional Notes
git add --resolvedwith and without conflict markers, a failedpre-commithook, and repeated-moptions with a trailer.npm run skill:validate,npm start,skills-ref validate,vally lint,codespell, andmarkdownlint-cli2. Only MD013 (line length) remains, as in other skills.By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.