github-pull-request-description
PopulaireWrite a description to description GitHub Pull Request.
Write a description to description GitHub Pull Request.
Description
We less than 150 words description for a PR changes, including new features, bug fixes, and improvements. And if there have APIs break changes (Only crates/ui changes) we should have a section called ## Breaking Changes to list them clearly.
Breaking changes description
When a pull request introduces breaking changes to a codebase, it's important to clearly communicate these changes to users and developers who rely on the code. A well-written breaking changes description helps ensure that everyone understands what has changed, why it has changed, and how to adapt to the new version.
We can get the changes from the PR diff and summarize them in a clear and concise manner. Aim to provide a clear APIs changes for users to follow.
Format
We pefer the following format for breaking changes descriptions:
- Use bullet list for each breaking change item.
- Each item should have title and a code block showing the old and new usage by use
diff. - Use
## Breaking Changesas the section title. - Use english language.
For example:
## Breaking Changes
- Added `id` parameter to `Sidebar::new`.
```diff
- Sidebar::new()
+ Sidebar::new("sidebar")
```
- Removed the `left` and `right` methods; use `side` instead.
> Default is left.
```diff
- Sidebar::right()
+ Sidebar::new("sidebar").side(Side::Right)
```
You Might Also Like
Related Skills
internal-comms
A set of resources to help me write all kinds of internal communications, using the formats that my company likes to use. Claude should use this skill whenever asked to write some sort of internal communications (status reports, leadership updates, 3P updates, company newsletters, FAQs, incident reports, project updates, etc.).
anthropics
write-pr
Writing pull request titles and descriptions for the tldraw repository. Use when creating a new PR, updating an existing PR's title or body, or when the /pr command needs PR content guidance.
tldraw
data-storytelling
Transform data into compelling narratives using visualization, context, and persuasive structure. Use when presenting analytics to stakeholders, creating data reports, or building executive presentations.
wshobsonemployment-contract-templates
Create employment contracts, offer letters, and HR policy documents following legal best practices. Use when drafting employment agreements, creating HR policies, or standardizing employment documentation.
wshobson
tailored-resume-generator
Analyzes job descriptions and generates tailored resumes that highlight relevant experience, skills, and achievements to maximize interview chances
ComposioHQcontent-research-writer
Assists in writing high-quality content by conducting research, adding citations, improving hooks, iterating on outlines, and providing real-time feedback on each section. Transforms your writing process from solo effort to collaborative partnership.
ComposioHQ