github-pull-request-description
π―Skillfrom longbridge/gpui-component
Generates concise, structured GitHub Pull Request descriptions with optional breaking changes documentation.
Installation
npx skills add https://github.com/longbridge/gpui-component --skill github-pull-request-descriptionSkill Details
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:
````md
Breaking Changes
- Added
idparameter toSidebar::new.
```diff
- Sidebar::new()
+ Sidebar::new("sidebar")
```
- Removed the
leftandrightmethods; usesideinstead.
> Default is left.
```diff
- Sidebar::right()
+ Sidebar::new("sidebar").side(Side::Right)
```
````
More from this repository10
Enforces consistent GPUI component design patterns by providing a comprehensive style guide for creating and reviewing Rust UI components.
Enables asynchronous operations and background tasks in GPUI, allowing seamless coordination between UI updates and concurrent computations.
Enables type-safe event handling, subscriptions, and observations for coordinating component interactions in GPUI applications.
Provides CSS-like layout and styling for Rust GPUI components using type-safe, chainable methods for flexbox, sizing, colors, and spacing.
Manages application state through safe, concurrent entities with read, update, and weak reference capabilities for reactive and async-friendly state handling in GPUI.
Enables keyboard-driven focus management and navigation between focusable elements in GPUI user interfaces.
Defines and manages keyboard-driven actions and key bindings for declarative UI interactions in GPUI applications.
gpui-context skill from longbridge/gpui-component
Enables comprehensive testing of GPUI applications with deterministic, single-threaded test execution for UI components and async operations.
Enables low-level, performance-critical custom UI element creation with precise control over layout, painting, and interaction phases in GPUI.