commit-pr-writer
/commit-pr-writer
Write commit messages in Conventional Commits format and pull request descriptions from a fixed template, based on the actual staged diff. Use when the user asks for a commit message, wants to split changes into commits, or needs a PR title and description written or cleaned up.
- Author
- thisiskurubaran ↗
- Repository
- DevSecOps ↗
- Licence
- MIT
- Last repository change
- 07.11.2026
Assessment and security
- Files in this package
- 3
- Scripts
- 1
- HTML comments
- 0
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 07.11.2026, without references to retired models or APIs.
MIT, open: use and modify while retaining author attribution.
- 1 scripts in this package. Review them before installing, as Claude may execute them.
Scripts: scripts/check-commit-msg.sh
What it does and when to use it
Write commit messages in Conventional Commits format and pull request descriptions from a fixed template, based on the actual staged diff. Use when the user asks for a commit message, wants to split changes into commits, or needs a PR title and description written or cleaned up.
Original author description
Write commit messages in Conventional Commits format and pull request descriptions from a fixed template, based on the actual staged diff. Use when the user asks for a commit message, wants to split changes into commits, or needs a PR title and description written or cleaned up.
How it works
- When to use
- Steps
- Checklist
- Output format
- Examples
SKILL.md preview
---
name: commit-pr-writer
description: Write commit messages in Conventional Commits format and pull request descriptions from a fixed template, based on the actual staged diff. Use when the user asks for a commit message, wants to split changes into commits, or needs a PR title and description written or cleaned up.
---
# Commit and PR Writer
Turn a diff into a commit message and a PR description that a reviewer can act on. Describe what changed and why, in the project's format, and nothing the diff does not show.
## When to use
- "Write a commit message for this", "what should I call this commit?"
- The user has a pile of unstaged changes and wants them split into logical commits.
- "Write the PR description", "fill in the PR template", "clean up this PR body".
Not for: release notes and changelog entries (use `docs-writer` or `release-checklist`), reviewing the code itself (use `code-review`).
## Steps
1. Read the real change, not the user's summary of it:
- Commit: `git diff --staged` and `git diff --staged --stat`.
- PR: `git log --oneline origin/main..HEAD` and `git diff --stat origin/main...HEAD`.
2. Check the project's format before using the default:
- `commitlint.config.*`, `.commitlintrc*`, or a `commit-msg` hook in `.husky/` or `.git/hooks/`.
- `.github/pull_request_template.md` or `.github/PULL_REQUEST_TEMPLATE/`.
- `git log --oneline -20` to copy the scope names and tone the team already uses.
3. Decide if this is one commit or several. Split when the diff mixes:
- A refactor and a behavior change.
- Two unrelated features or fixes.
- Formatting churn and real edits.
Suggest `git add -p` or explicit paths per commit. Never suggest `git add .` for a split.
4. Pick the type and scope (see Checklist). Scope is the module, package or folder, lowercase.
5. Write the summary line: imperative mood, lowercase after the colon, no trailing period, under 72 characters total.
6. Write a body when the reason is not obvious from the summary. Explain why, the old behavior, and any risk. Wrap at 72 characters.
7. Add footers only when they apply: `BREAKING CHANGE: ...`, `Refs: #123`, `Closes #123`.
8. For a PR, fill the template below (or the repo's template). Pull testing steps from the test files in the diff.
9. Validate the message. Run `scripts/check-commit-msg.sh <file>` or `npx commitlint --edit <file>` if the repo has commitlint.
10. Show the message to the user. Do not run `git commit` or `gh pr create` unless they ask.
## Checklist
Types (Conventional Commits 1.0.0):
| Type | Use for |
|---|---|
| feat | New user-facing behavior |
| fix | Bug fix |
| docs | Docs only |
| refactor | Code change with no behavior change |
| perf | Faster or lighter, same behavior |
| test | Tests only |
| build | Build system, dependencies, Dockerfile |
| ci | Pipeline config (`.github/workflows/`, `.gitlab-ci.yml`) |
| chore | Tooling and housekeeping that fits nothing else |
| revert | Reverting an earlier commit |
Summary line:
- Matches `^(feat|fix|docs|refactor|perf|test|build|ci|chore|revert)(\([a-z0-9-]+\))?!?: .+`.
- 72 characters or fewer.
- Imperative: "add", "fix", "remove", not "added" or "adds".
- Says what changed, not "update files" or "misc fixes".
- `!` after the scope, or a `BREAKING CHANGE:` footer, for any breaking API, config or schema change.
Body:
- Blank line between summary and body.
- Explains why. The diff already shows what.
- Mentions any security impact plainly (for example "stops logging the session token").
- No secrets, internal hostnames, customer names or ticket text with personal data.
PR description:
- Title follows the same format as a commit summary (squash merges reuse it).
- Links the issue with `Closes #N` so GitHub closes it on merge.
- Testing section lists commands a reviewer can run.
- Calls out migrations, new env vars, feature flags and rollback steps.
- Screenshots or sample output for UI or CLI changes.
- No attribution trailers or tool signatures unless the project's template asks for them.
## Output format
Commit message:
```text
<type>(<scope>): <summary under 72 chars>
<why this change, wrapped at 72 chars>
<footers: BREAKING CHANGE, Refs, Closes>
```
PR description:
```markdown
## What
<two or three sentences on the change>
## Why
<problem it solves, link to issue>
Closes #<n>
## How
- <key implementation point>
- <key implementation point>
## Testing
- [ ] `<command a reviewer can run>`
- [ ] <manual step and expected result>
## Risk and rollback
<what could break, how to roll back, flags or migrations involved>
## Checklist
- [ ] Tests added or updated
- [ ] Docs updated
- [ ] No secrets or personal data in code, logs or fixtures
```
When splitting, output a numbered list: files for each commit, then each message.
## Examples
Bad commit:
```text
Updated stuff and fixed bug
```
Good commit:
```text
fix(auth): reject expired refresh tokens
The refresh endpoint checked the signature but not the exp claim, so
a stolen refresh token stayed valid forever. Validate exp and return
401 with error=invalid_grant.
Closes #412
```
Bad split (one commit for everything):
```text
feat: new export, rename helpers, bump eslint
```
Good split:
```text
1. refactor(utils): rename date helpers to match module names
files: src/utils/date.ts, src/utils/date.test.ts
2. feat(reports): add csv export for monthly report
files: src/reports/export.ts, src/reports/export.test.ts
3. build(deps): bump eslint to 9.12.0
files: package.json, package-lock.json
```
Bad breaking change (no marker):
```text
feat(api): change /users response to paginated object
```
Good:
```text
feat(api)!: return paginated object from /users
BREAKING CHANGE: GET /users now returns {"items": [...], "next": "..."}
instead of a bare array. Clients must read .items.
```
Files in this package (3)
- SKILL.md 6 KB
- examples/test-prompts.md 1 KB
- scripts/check-commit-msg.sh 1 KB
Versions
The database has no other skills named commit-pr-writer.
Database snapshot: 13.11.2026 · package version 204ae050dedf (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100commit-and-pr-writer
Write Conventional Commit messages and PR descriptions from a git diff, with a diff scanner and message linter. Use for 'commit message', 'PR description', 'summarize my changes', 'split commits'. - 100commit-message
Write a Conventional Commits message from a real diff. Use when a user asks to write, fix, or review a commit message, or to turn a set of changes into a clear commit. Works from the actual diff and the files it touches, never from a vague summary, and refuses messages that say nothing. - 100plei-git
Write and review Git commit messages using Conventional Commits 1.0.0, or draft clear pull request descriptions for any project. Use when preparing commit messages or PR summaries; follow a repository's own conventions when they differ. - 95git-commits
Write clear, semantic git commit messages and PR/MR titles following Conventional Commits. Use when the user asks to write commit messages, format git history, improve commit quality, or set a PR/MR title, or mentions "commit message", "conventional commits", "merge message", or… - 100commit-message
Write a clear Conventional Commits message from the staged changes (or a described change), and split work into sensible commits when a diff mixes unrelated changes. Use when the user says "commit this", "write a commit message", "what should the commit say", "fix my commit… - 100commit-craft
Writes precise Conventional Commits messages from the actual staged diff and splits mixed work into logical commits. Use when the user asks to commit, write or fix a commit message, squash, or "clean up" git history before a push.