Skip to content

Latest commit

 

History

History
77 lines (50 loc) · 1.9 KB

CHANGELOG.md

File metadata and controls

77 lines (50 loc) · 1.9 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Added

  • Describe new features added in this version.

Changed

  • Describe changes in existing functionality.

Deprecated

  • List features that are still available but will be removed in future versions.

Removed

  • List features that have been removed.

Fixed

  • List any bug fixes.

Security

  • Describe security fixes or improvements.

[0.1.0] - 2024-12-18

Added

  • Project setup.
  • Initial functionality implemented.

How to Use This Changelog

  • Added: For new features.
  • Changed: For changes in existing functionality.
  • Deprecated: For features that will soon be removed.
  • Removed: For features that have been removed.
  • Fixed: For bug fixes.
  • Security: In case of vulnerabilities addressed.

Versioning

This project uses Semantic Versioning (MAJOR.MINOR.PATCH):

  • MAJOR: Incompatible API changes.
  • MINOR: Backward-compatible new features.
  • PATCH: Backward-compatible bug fixes.

For example:

  • 1.0.0: Major release with breaking changes.
  • 1.1.0: New backward-compatible feature.
  • 1.1.1: Bug fix or minor change.

Contributing to the Changelog

When contributing changes, ensure you update the [Unreleased] section of this file with a brief description of your contribution.

  • Use clear, concise language.
  • Categorize your change under Added, Changed, Deprecated, Removed, Fixed, or Security.

When releasing a new version:

  1. Move changes from [Unreleased] to a new section with the version number and release date.
  2. Update any relevant documentation if necessary.

Thank you for helping us maintain a clean and clear changelog! 🚀