skills.rest
superplanehq
superplanehqOFFICIAL
Explore all skills by this author →
Website𝕏@superplanehqGitHub

commit-and-pr-messages

Write Git commit messages and pull request descriptions using Conventional Commits and Simplified Technical English.

5.7k|625|Updated May 7, 2025
Search Tags:#writing#Git#commit message#Conventional Commits#Code review#Pull request#simplified technical english
One-click install
npx skills add https://github.com/superplanehq/superplane --skill commit-and-pr-messages
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: commit-and-pr-messages
Source: https://github.com/superplanehq/superplane/tree/main/.agents/skills/commit-and-pr-messages
Command: npx skills add https://github.com/superplanehq/superplane --skill commit-and-pr-messages

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Inconsistent commit messages and vague pull request descriptions make Git history hard to scan, search, and review. This Skill enforces the Chris Beams / Tim Pope commit conventions plus ASD-STE100 Simplified Technical English so every commit and PR clearly explains what changed and why.

Core Features & Use Cases

  • Commit Message Rules: Applies the seven classic rules including subject/body split, ~50-character imperative subjects, 72-character body wrapping, and why-not-how explanations.
  • PR Titles and Descriptions: Generates Conventional Commits titles (feat:, fix:, chore:, docs:) and structured PR bodies with Summary and Test plan sections written in STE.
  • SuperPlane Conventions: Adds DCO sign-off trailers, issue references, and a pre-submission quality checklist.
  • Use Case: After staging changes for a bug fix, ask for a commit message and receive a properly formatted fix: subject with an STE body explaining the motivation, plus a Signed-off-by trailer.

Quick Start

Ask the assistant to write a commit message and PR description for your staged changes following the commit-and-pr-messages conventions.

Frequently Asked Questions about commit-and-pr-messages

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a good Git commit message?▼

Follow the seven rules: separate subject from body with a blank line, keep the subject near 50 characters, capitalize it, omit the trailing period, use imperative mood, wrap the body at 72 characters, and explain what and why rather than how.

How to write a pull request description with Conventional Commits?▼

Use a release-type prefix like feat:, fix:, chore:, or docs: followed by an imperative capitalized summary. In the body, include a Summary section explaining why the change exists and a Test plan checklist, both written in Simplified Technical English.

What is ASD-STE100 Simplified Technical English in PR descriptions?▼

ASD-STE100 is a controlled writing standard using short sentences, active voice, no contractions, and no slang. This Skill applies it to commit bodies and PR summaries, limiting descriptive sentences to 25 words and test steps to 20 words.

Does this convention require a DCO sign-off in commits?▼

Yes, commits should include a Signed-off-by trailer added with git commit -s to satisfy the Developer Certificate of Origin requirement. Issue references belong at the end of the body rather than in the subject line.

When should a commit be split into multiple commits?▼

Split commits when the subject line is hard to write, which signals the commit does too much. Aim for one logical change per commit so each message stays short, imperative, and scannable.

Related Skills

Explore More Software Engineering Skills→
fascarifascari

committing-changes

Organize repository changes into approved commits with explicit user confirmation.

Community
Advanced
0xharryriddle0xharryriddle
3

git-pr-workflow

Prepare pull requests with atomic commits, conventional messages, and CI checks.

Community
Intermediate
NousResearchNousResearch
239.1k

simple-english

Rewrite technical text to comply with ASD-STE100 Simplified Technical English rules.

Official
Intermediate
zenbuappszenbuapps

git-commit

Generates conventional commit messages and stages relevant changes from diffs.

Official
Advanced