-
-
Notifications
You must be signed in to change notification settings - Fork 32
Release Template
Pranay Kothapalli edited this page Aug 31, 2024
·
1 revision
-
[Feature Name]: Brief description of the feature and how it benefits users. Include links to relevant documentation if available.
- Example:
Added a new responsive grid system to easily create fluid layouts. [See Documentation](#link)
- Example:
-
[Improvement Name]: Briefly describe improvements or optimizations made.
- Example:
Optimized button component rendering, reducing re-render times by 20%.
- Example:
-
[Issue/PR Number]: Description of the bug fixed and its impact.
- Example:
Fixed an issue where the dropdown menu would not close on outside click. ([#421](#link))
- Example:
-
[Section Name]: List any updates to the documentation.
- Example:
Updated the API documentation for the modal component to include new props. ([#422](#link))
- Example:
-
[Dependency Name]: Mention any updates to dependencies that users should be aware of.
- Example:
Updated React version to 18.2.0.
- Example:
-
[Change Name]: Describe the breaking change and steps to migrate.
- Example:
Removed support for IE11. Users should migrate to modern browsers. ([Migration Guide](#link))
- Example:
-
Installation: Provide commands or instructions for new installations.
- Example:
npm install @rad-ui/ui@latest
- Example:
-
Upgrade: Provide commands or instructions for upgrading.
- Example:
npm update @rad-ui/ui
- Example:
- Mention the contributors who helped with this release.
- Example:
Thanks to @username for their contributions in improving accessibility.
- Example:
- Provide links to a demo or a preview of the new release.
- Example:
Check out the live demo of the new grid system [here](#link).
- Example: