Skip to content

refactor(v2.0.0 release): user-defined tags, project storage, and documentation standards#9

Merged
bryan-shea merged 3 commits intomainfrom
feat/updates-optimizations
Feb 1, 2026
Merged

refactor(v2.0.0 release): user-defined tags, project storage, and documentation standards#9
bryan-shea merged 3 commits intomainfrom
feat/updates-optimizations

Conversation

@bryan-shea
Copy link
Owner

PR Description

v2.0.0 Release

This major release introduces a simplified UX through user-defined tags and project-scoped storage, alongside comprehensive documentation standards. This is a breaking change release due to the removal of preset tags.

Previous Version: v1.5.0 (Dec 26, 2025)
New Version: v2.0.0

Breaking Changes ⚠️

User-Defined Tags System (Major Change)

  • BREAKING: Removed all preset tags in favor of a flexible user-defined system
  • Users can now create, edit, and delete custom tags for their specific workflows
  • Enhanced tag management with dedicated CRUD operations
  • Added custom status support to annotation storage

Migration Guide: Users upgrading from v1.5.0 will need to create custom tags matching their previous workflows. Documentation includes recommended tag templates for common use cases.

Core Changes

Architecture & Storage

  • Implemented project-scoped .annotative/ folder for isolated, portable storage
  • Storage manager now auto-creates project-specific folders on first use
  • Annotations remain workspace-independent and version-control friendly

UX Improvements

  • Streamlined all command messages for concise, professional communication
  • Improved error handling and user feedback across all commands
  • Enhanced clarity in UI labels and terminology

Documentation Standards

  • Complete rewrite of README with accurate terminology and professional tone
  • Comprehensive CONTRIBUTING guidelines for developers
  • Standardized CHANGELOG format with semantic versioning
  • Updated package.json description to reflect professional positioning
  • New SUPPORT.md for user assistance and troubleshooting
  • Removed all emojis from user-facing content and extension code
  • Updated copilot-instructions to reflect current architecture
  • All documentation now uses exact command names and consistent terminology

Files Changed

  • Core extension functionality and command system
  • Storage and tag management
  • All user-facing documentation (README, CONTRIBUTING, CHANGELOG, SUPPORT)
  • Extension UI labels and copilot-instructions configuration
  • package.json (version updated to 2.0.0)

Testing Recommendations

  • Create custom tags and verify storage in .annotative/ folder
  • Test tag CRUD operations (create, edit, delete)
  • Verify annotations persist across VS Code restarts
  • Confirm error messages are clear and actionable
  • Review all user-facing text for professional tone
  • Test upgrade path from v1.5.0

Related Issues

Addresses simplification of tag system and documentation standardization across the project.

Version Bump Justification

Semantic Versioning: Major version bump (2.0.0) due to breaking change in tag system API.

BREAKING CHANGE: Removed all preset tags in favor of user-defined system

- Implemented project-scoped .annotative folder for isolated storage
- Streamlined all command messages for concise, professional UX
- Enhanced tag management with create, edit, delete workflows
- Added custom status support to annotation storage
- Improved error handling and user feedback across all commands
- Updated storage manager to auto-create project-specific folders
- Rewrite README with accurate terminology and professional tone
- Remove all emojis from user-facing content
- Update CONTRIBUTING with comprehensive developer guidelines
- Standardize CHANGELOG format and remove git hashes
- Update package.json description to match documentation tone
- Remove emojis from color picker labels in extension code
- Update copilot-instructions to reflect current architecture
- Add SUPPORT.md for user assistance

All documentation now uses exact command names and terminology from the extension, maintains a professional tone, and follows established standards.
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request implements v2.0.0 of the Annotative extension, introducing user-defined tags as a replacement for preset tags and streamlining documentation and user messaging. This is a major breaking change release that removes all preset tag functionality.

Changes:

  • Removed all preset tags (bug, performance, security, etc.) in favor of a fully user-defined tag system
  • Streamlined command messages and UI text throughout the extension for consistency
  • Comprehensive documentation rewrite including README, CONTRIBUTING, CHANGELOG, and new SUPPORT.md
  • Added AnnotationStatus interface for future status management (not yet implemented)
  • Enhanced project storage with auto-creation on first use
  • Removed emojis from color palette labels in extension code

Reviewed changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 17 comments.

Show a summary per file
File Description
src/types.ts Added AnnotationStatus interface and updated tag/annotation comments to reflect user-defined system
src/tags/tagRegistry.ts Removed all preset tag initialization, now returns empty array for presets
src/tags/tagManager.ts Updated methods to work exclusively with custom tags, deprecated preset methods
src/managers/annotationStorage.ts Added status persistence, auto-creates project storage, deprecated old initialization method
src/extension.ts Removed emoji icons from color palette labels
src/commands/tags.ts Updated all tag commands to handle empty tag state and guide users to create tags
src/commands/sidebar.ts Streamlined storage initialization messages
src/commands/filters.ts Shortened UI messages for consistency
src/commands/export.ts Condensed success/error messages throughout
src/commands/bulk.ts Added tag existence checks before bulk tag operations
src/commands/annotation.ts Updated templates to have empty tag arrays, improved tag selection flow
media/sidebar-webview.js Updated to handle user-defined tags only with empty state
package.json Updated command titles and descriptions, configuration labels shortened
README.md Complete rewrite with professional tone, accurate terminology, structured sections
CONTRIBUTING.md Expanded with detailed development setup, architecture, and standards
CHANGELOG.md Standardized format with consistent structure
SUPPORT.md New file providing user support resources and troubleshooting
.github/copilot-instructions.md Updated with accurate architecture, removed emoji policy
.husky/pre-commit Removed shebang and husky initialization lines
.husky/commit-msg Removed shebang and husky initialization lines

@bryan-shea bryan-shea merged commit 90e81af into main Feb 1, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants