Skip to main content
All notable changes to the achievements-manager library are documented here.

​
Release Channels

​
Stable

Install the latest stable version: 
pnpm add achievements-react
# or
npm install achievements-react

​
Canary

Experimental features and upcoming changes: 
pnpm add achievements-react@canary
Canary builds may contain breaking changes and are not recommended for production.

​
Versioning Policy

This project follows Semantic Versioning:
  • Major (1.0.0 → 2.0.0): Breaking changes to public API
  • Minor (1.0.0 → 1.1.0): New features, backward compatible
  • Patch (1.0.0 → 1.0.1): Bug fixes, backward compatible

​
Breaking Changes

Breaking changes are documented in:
  1. This changelog under the major version
  2. The Migration Guide
  3. GitHub release notes

​
Deprecation Policy

Before removing features:
  1. Feature marked as deprecated in a minor release
  2. Console warnings added with upgrade path
  3. Minimum one major version before removal
  4. Migration guide provided

​
Upgrade Recommendations

​
Patch Updates

Safe to upgrade immediately. No code changes required. 
pnpm update achievements-react

​
Minor Updates

Review changelog for new features. Existing code continues to work. 
pnpm add achievements-react@latest

​
Major Updates

Read the Migration Guide before upgrading: 
pnpm add [email protected]

​
Contributing

See Contributing Guide for development workflow and release process.

Build docs developers (and LLMs) love

Get started for freeTalk to us