pr-description-template

To generate standardized PR descriptions for GitHub code reviews, use this skill to apply canonical structures with sections like Summary, What's Included, and Key Design Decisions. It enforces consistent PR documentation for features, bug fixes, and refactors.

A PR description template for a bug fix should include standardized sections like Summary, What's Included, Key Design Decisions, and Testing Notes. This ensures all necessary information for formal PR documentation is provided to reviewers and maintainers.

Yes, the PR template generator supports different code change types. It provides selectable template-based generation for feature, bugfix, refactor, and format PRs, ensuring the documentation fits the specific code change context.

To tailor a PR description to reviewers and maintainers, the skill provides guidance on what to include and how to adjust the content for the audience. It uses a quick-start workflow and examples to generate descriptions from templates and checklists.

The best way to standardize PR documentation across a software development team is to enforce a canonical PR description structure. This skill provides templates with consistent sections for features and refactors, speeding up reviews and ensuring necessary information is included.

Yes, you can use this PR description template for refactoring code. It includes specific templates for refactor PRs, applying a canonical structure with sections like Summary and Key Design Decisions to document the code changes accurately.