github-writing

Write GitHub issues, PR descriptions, review comments, and commit messages.

1|Updated Mar 24, 2026
One-click install
npx skills add https://github.com/SgtPooki/skills --skill github-writing-sgtpooki
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: github-writing
Source: https://github.com/SgtPooki/skills/tree/main/skills/github-writing
Command: npx skills add https://github.com/SgtPooki/skills --skill github-writing-sgtpooki

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? GitHub issues, PR descriptions, and commit messages often bury the actionable point under filler, private-conversation context, or pasted investigation logs, forcing teammates to dig for what matters. This Skill produces self-contained, scannable GitHub text that a teammate can understand and act on in under 60 seconds. ## Core Features & Use Cases - Structured Issue and PR Templates: Enforces sections like Description, Impact, Steps to Reproduce, and What changed, with soft length targets (~150-250 words for issues, ~100-200 for PRs). - Commit Message and Review Comment Rules: Applies Chris Beams' commit conventions (imperative mood, 50-char subject, 72-char body wrap) and Conventional Comments labels (blocking, non-blocking, question, suggestion). - Investigation Splitting: Routes long evidence, logs, and option analysis into linked Gists or Notion docs while keeping the GitHub issue focused on the actionable decision. - Use Case: After debugging a production bug, use this Skill to turn raw investigation notes into a concise GitHub issue summarizing root cause, impact, and next step, with the full evidence linked as a secret Gist. ## Quick Start Ask the agent to write a GitHub issue for the bug you just investigated, following the github-writing structure and gating the draft through the writingcheck script.

Frequently Asked Questions about github-writing

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

FAQPage Schema
How do I write a good GitHub issue for a bug report?▼

Start with the core problem in the first sentence, then add Impact, numbered Steps to Reproduce, Expected Behavior, and Actual Behavior. Keep it around 150-250 words, omit empty sections, and link logs or repros instead of pasting them.

How to write a clear PR description on GitHub?▼

Only the What changed section is required: 1-2 sentences explaining the change and why. Add How to verify with reviewer commands and Notes/risks for migrations or behavior changes, targeting roughly 100-200 words total.

What commit message format should I use?▼

Use imperative mood in the subject ("Fix retry starvation", never "Fixed"), keep the subject under 50 characters, and wrap the body at 72 characters. Follow the repo's existing convention, including Conventional Commits only if the repo already uses them.

When should I split an investigation into a separate doc?▼

Split when the source is long or contains multiple findings. Keep the GitHub issue short with root cause, impact, workaround, and next step, and move evidence, logs, and rejected options into a linked secret Gist or Notion memo.

Does this skill work for documentation or release notes?▼

No. It explicitly excludes persistent docs (handled by writing-docs), decision records (writing-spec), and public announcements or release notes (writing-community). It covers only change-oriented GitHub tracker and review text.