Skip to content

Release Template

Pranay Kothapalli edited this page Aug 31, 2024 · 1 revision

Release Title (e.g., vX.Y.Z - Feature/Improvement Title)

πŸš€ New Features

  • [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)

πŸ› οΈ Improvements

  • [Improvement Name]: Briefly describe improvements or optimizations made.
    • Example: Optimized button component rendering, reducing re-render times by 20%.

πŸ› Bug Fixes

  • [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))

πŸ“š Documentation Updates

  • [Section Name]: List any updates to the documentation.
    • Example: Updated the API documentation for the modal component to include new props. ([#422](#link))

πŸ”„ Dependency Updates

  • [Dependency Name]: Mention any updates to dependencies that users should be aware of.
    • Example: Updated React version to 18.2.0.

⚠️ Breaking Changes

  • [Change Name]: Describe the breaking change and steps to migrate.
    • Example: Removed support for IE11. Users should migrate to modern browsers. ([Migration Guide](#link))

πŸ“¦ Installation & Upgrade

  • Installation: Provide commands or instructions for new installations.
    • Example: npm install @rad-ui/ui@latest
  • Upgrade: Provide commands or instructions for upgrading.
    • Example: npm update @rad-ui/ui

❀️ Thanks to Contributors

  • Mention the contributors who helped with this release.
    • Example: Thanks to @username for their contributions in improving accessibility.

πŸ‘€ Preview & Demos

  • 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).