Skip to content

CHANGELOG.md

Latest commit

 

History

History
151 lines (106 loc) · 4 KB

CHANGELOG.md

File metadata and controls

151 lines (106 loc) · 4 KB
Raw

Changelog

All notable changes to the ObjectStack Protocol will be documented in this file.

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

Unreleased

Added

Changed

Deprecated

Removed

Fixed

Security

0.3.1 - 2026-01-23

Changed

  • Organized zod schema files by folder structure
  • Improved project documentation

0.3.0 - 2026-01-22

Added

  • Comprehensive documentation structure with CONTRIBUTING.md
  • Documentation hub at docs/README.md
  • Standards documentation (naming-conventions, api-design, error-handling)
  • Architecture deep dives (data-layer, ui-layer, system-layer)
  • Code of Conduct
  • Changelog template
  • Migration guides structure
  • Security and performance guides

Changed

  • Updated README.md with improved documentation navigation
  • Enhanced documentation organization following industry best practices
  • All packages now use unified versioning (all packages released together with same version number)

0.1.1 - 2026-01-20

Added

  • Initial protocol specifications
  • Zod schemas for data, UI, system, AI, and API protocols
  • JSON schema generation
  • Basic documentation site with Fumadocs
  • Example implementations (CRM, Todo)

Template for Future Releases

## [X.Y.Z] - YYYY-MM-DD

### Added
- New features or capabilities

### Changed
- Changes to existing functionality

### Deprecated
- Features that will be removed in upcoming releases

### Removed
- Features that have been removed

### Fixed
- Bug fixes

### Security
- Security-related changes

How to Use This Changelog

For Contributors

When making changes:

  1. Add entries under [Unreleased] section
  2. Choose the appropriate category: Added, Changed, Deprecated, Removed, Fixed, Security
  3. Write clear, concise descriptions of your changes
  4. Link to PRs or issues where applicable: - Feature description (#PR_NUMBER)

Example:

### Added
- New encrypted field type for sensitive data (#123)
- Support for PostgreSQL window functions in query protocol (#124)

### Fixed
- Validation error when using lookup fields with filters (#125)

For Maintainers

When releasing a new version:

  1. Create a new version section from the [Unreleased] content
  2. Move entries from [Unreleased] to the new version section
  3. Add release date in YYYY-MM-DD format
  4. Tag the release in git: git tag -a v0.2.0 -m "Release v0.2.0"
  5. Update links at the bottom of the file

Versioning Guide

Following Semantic Versioning:

  • MAJOR version (X.0.0): Incompatible API changes
  • MINOR version (0.X.0): Add functionality in a backward compatible manner
  • PATCH version (0.0.X): Backward compatible bug fixes

Categories

  • Added: New features, protocols, schemas, or capabilities
  • Changed: Changes to existing functionality
  • Deprecated: Features marked for removal (but still working)
  • Removed: Features that have been removed
  • Fixed: Bug fixes
  • Security: Security vulnerability fixes or improvements

Breaking Changes

Mark breaking changes clearly:

### Changed
- **BREAKING**: Renamed `maxLength` to `maxLen` in FieldSchema (#126)
  Migration: Update all field definitions to use `maxLen` instead of `maxLength`

Release Process

  1. Update CHANGELOG.md with release notes
  2. Update version in package.json files
  3. Run pnpm changeset version to update package versions
  4. Commit changes: git commit -m "chore: release vX.Y.Z"
  5. Create git tag: git tag -a vX.Y.Z -m "Release vX.Y.Z"
  6. Push: git push && git push --tags
  7. Run pnpm release to publish packages