pr-description-writing

Draft conventional commit PR titles and Shopware 5-section descriptions.

41|5|Updated Oct 22, 2025
One-click install
npx skills add https://github.com/shopwareLabs/ai-coding-tools --skill pr-description-writing
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-description-writing
Source: https://github.com/shopwareLabs/ai-coding-tools/tree/main/plugins/contributor-writing/skills/pr-description-writing
Command: npx skills add https://github.com/shopwareLabs/ai-coding-tools --skill pr-description-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Draft PR titles (conventional commit format) and complete PR descriptions that explain why changes were made, what they do, and how to verify them.

Core Features & Use Cases

  • Phase-driven drafting: detects branch state, target base, and scope to guide the PR content.
  • Generates a conventional commit title and a Shopware 5-section PR description (Why, What, How to Reproduce, References).
  • Enforces Shopware writing guidelines and anti-slop rules by referencing project rules during drafting.

Quick Start

Trigger the drafting by providing the feature branch and any existing PR notes to generate a ready-to-use draft.

Frequently Asked Questions about pr-description-writing

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

FAQPage Schema
How do I write a pull request description for Shopware projects?

Drafting a Shopware pull request description involves detecting the feature branch state and diff to generate a conventional commit title and a 5-section description covering Why, What, How to Reproduce, and References.

What is the conventional commit format for pull request titles?

The conventional commit format for PR titles structures the change type and scope directly from the branch analysis, producing a standardized title that clearly communicates the modification context for Shopware projects.

How do I generate a PR title from a feature branch diff?

Generating a PR title from a feature branch diff requires analyzing the changes against the trunk branch, detecting the modification scope, and formatting the result into a conventional commit title.

Does the Shopware PR description template include testing instructions?

Yes, the Shopware PR description template includes a How to Reproduce section to provide testing and verification instructions for the submitted changes, ensuring reviewers can validate the modifications.

What is the best way to automate pull request drafting for Shopware?

Automating Shopware pull request drafting is best achieved through a phase-driven workflow that detects the branch state, analyzes the diff, gathers missing context, and enforces Shopware writing guidelines and anti-slop rules.

Why does my PR description get rejected for not following Shopware guidelines?

Your PR description may be rejected for violating Shopware writing guidelines or anti-slop rules, which require a specific 5-section template and conventional commit formatting that can be enforced during the drafting phase.