Discourse/discourse
Discourse/discourse
0
0
Fork 0
mirror of https://gh.wpcy.net/https://github.com/discourse/discourse.git synced 2026-05-28 16:55:47 +08:00
Code Packages Activity Actions
discourse/.skills/discourse-pr/SKILL.md
Keegan George e2af5f6054
DEV: Add discourse-pr skill for generating commit messages (#39310) 
**Previously**, there was no automated way to generate Discourse-style
commit messages and PR descriptions from branch changes.

**In this update**, added a `.skills/discourse-pr/SKILL.md` skill that
analyzes diffs and produces correctly formatted commit messages with the
appropriate prefix and a two-sentence PR description.
2026-04-16 07:33:54 -07:00

2.3 KiB
Vendored
Raw Permalink Blame History

name description
discourse-pr Generate a Discourse-style commit message and PR description from current changes

Look at the changes made in the current branch compared to the base branch (usually main). If we're not on a branch other than main, use the changes made in the current conversation session instead.

Also read the Claude Code System Prompt for additional context on what was done and why.

From those changes, generate a commit message and PR description following these exact Discourse conventions:

Commit Message Rules

  • Use exactly ONE of these uppercase prefixes, followed by a colon and space:
    • FIX: — A bug fix
    • PERF: — A performance improvement
    • UX: — A user interface change
    • SECURITY: — A security problem fix
    • FEATURE: — An added feature
    • A11Y: — An accessibility improvement
    • I18N: — Translation updates
    • MT: — Changes to migrations tooling
    • DEV: — A Discourse internals change that doesn't fit the above
  • Use imperative mood (e.g., "Add X", "Fix Y") and sentence case.
  • Wrap code symbols, method names, or file paths in backticks.
  • Do NOT include a trailing period or a commit body.
  • Output a single subject line only.

PR Description Rules

Immediately after the commit message, output a Markdown PR description using exactly this format:

Previously, [brief description of the old state or issue].

In this update, [brief description of the change].

Keep both sections extremely brief — ideally one sentence each.

Constraints

  • Never use lowercase "conventional commit" prefixes (e.g., fix:, feat:).

Example Output

UX: Improve `UserSelector` contrast for dark mode

**Previously**, the text in the `UserSelector` component was difficult to read on dark backgrounds due to low contrast.

**In this update**, updated the text color to use the `--primary-medium` CSS variable.

Steps

  1. Determine the diff: run git diff main...HEAD (or fall back to session changes).
  2. Read through the changed files to understand the purpose of the changes.
  3. Pick the single most appropriate prefix based on the nature of the change.
  4. Write the commit message subject line.
  5. Write the two-sentence PR description.
  6. Output both together, ready to copy.