Files
issue-core/CHANGELOG.md
tegwick 70d7ec0cdc docs: add CHANGELOG.md documenting v1.0.0 release
Add comprehensive CHANGELOG following Keep a Changelog format to document
the architecture refactoring and feedback capability implementation.

Documented in v1.0.0:
- ReusableCapabilitiesArchitecture specification
- Feedback capability with visible directory structure
- Detachment facility for capability removal
- Enhanced documentation (CLAUDE.md, README.md, examples)
- Directory visibility changes (.feedback → feedback)
- Explicit family declaration (CAPABILITY-issue-tracking.yaml)

Also includes version history from v0.1.0 through v0.9.0 and
upgrade notes for migrating to v1.0.0.

Closes the documentation gap referenced in TODO.md.
2025-12-17 22:54:27 +01:00

6.1 KiB

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

  • Nothing yet

Changed

  • Nothing yet

Deprecated

  • Nothing yet

Removed

  • Nothing yet

Fixed

  • Nothing yet

Security

  • Nothing yet

[1.0.0] - 2025-12-17

Added - Architecture & Documentation

  • ReusableCapabilitiesArchitecture.md: Complete specification (1,182 lines) defining how capabilities are organized, discovered, and integrated by devhumans and devagents
  • Feedback capability: Lightweight, unstructured feedback collection system
    • feedback/ directory for user submissions (visible, not hidden)
    • .capability/feedback CLI tool for submission and management
    • feedback/README.md comprehensive documentation (367 lines)
    • Support for text, file, and direct submission methods
    • Maintainer workflow (list, review, archive, create issues)
  • Detachment facility: .capability/detach script for clean capability removal
    • Generates detachment manifest with re-integration guidance
    • Handles git submodules and directory-based integrations
    • Preserves git history and metadata

Changed - Architecture Compliance

  • Directory visibility: Renamed .feedback/feedback/ to make user interface visible
  • Explicit family declaration: Renamed CAPABILITY.yamlCAPABILITY-issue-tracking.yaml
  • Integration pattern: Established _<family>/<implementation> directory structure
    • Supports family-based organization enabling multiple implementations
    • Underscore prefix signals "integrated capability, not core code"
    • Reduces directory tree depth (3 levels vs 6+ levels)

Enhanced - Documentation

  • CLAUDE.md: Added 155 lines documenting feedback system integration
    • User submission methods
    • Maintainer workflow
    • Reusable pattern documentation
  • README.md: Complete rewrite (399 lines) focusing on agent coordination
    • Emphasis on natural language integration by AI coding agents
    • Use cases for multi-agent coordination
    • Current status and limitations clearly stated
  • CAPABILITY-issue-tracking.yaml: Enhanced with feedback section
    • Submission methods documented
    • Integration notes for other capabilities
    • Maintainer workflow guidance
  • Examples: Added examples/feedback-example.md (285 lines)
    • Multiple submission methods with examples
    • Feedback categories and best practices
    • What happens to feedback after submission

Technical - Reference Updates

  • Updated all documentation references from .feedback/ to feedback/
  • Updated all references from CAPABILITY.yaml to CAPABILITY-issue-tracking.yaml
  • Fixed Makefile commands to use new paths
  • Updated .capability/feedback script to use visible directory

Infrastructure

  • Established feedback as reusable pattern across all markitect capabilities
  • Created migration path for hidden → visible user interfaces
  • Documented capability family vs implementation distinction

[0.9.0] - 2024-12-15

Added

  • Comprehensive Gitea integration tests
  • GitLab backend groundwork
  • Enhanced agent integration documentation

Fixed

  • ID mapping bugs in issue-facade
  • Sync metadata handling
  • Backend initialization edge cases

[0.5.0] - 2024-11-10

Added

  • Capability Makefile for integration with markitect main project
  • Development command aliases (install, test, lint)
  • Integration targets for parent project

Changed

  • Improved capability isolation and composability
  • Enhanced testing infrastructure

[0.1.0] - 2024-10-06

Added

  • Initial extraction of issue-facade as standalone capability
  • Core CRUD operations (create, read, update, delete issues)
  • Gitea backend implementation (production-ready)
  • Local SQLite backend (offline capability)
  • Basic synchronization between backends
  • CLI with JSON output for agent consumption
  • Python programmatic API
  • Comprehensive test suite (109 tests, 61% coverage)

Architecture

  • Facade pattern with plugin architecture
  • Backend interface (ABC) for extensibility
  • Core domain models (Issue, Label, User, Milestone, Comment)
  • State management with backend-specific mapping

Documentation

  • README with usage examples
  • AGENT_INTEGRATION.md for autonomous agents
  • CLAUDE.md for development guidance
  • ROADMAP.md with implementation phases

Version History Summary

  • v1.0.0 (2025-12-17) - Architecture formalization, feedback capability, comprehensive documentation
  • v0.9.0 (2024-12-15) - Gitea integration tests, bug fixes
  • v0.5.0 (2024-11-10) - Capability Makefile, integration improvements
  • v0.1.0 (2024-10-06) - Initial extraction, core functionality

Upgrade Notes

Upgrading to v1.0.0

Breaking Changes:

  • File paths updated (.feedback/feedback/)
  • Capability spec renamed (CAPABILITY.yamlCAPABILITY-issue-tracking.yaml)

Migration Steps:

# If you have a clone/fork, update references:
find . -name "*.md" -exec sed -i 's/\.feedback\//feedback\//g' {} +
mv CAPABILITY.yaml CAPABILITY-issue-tracking.yaml

# Update any integration scripts to use new paths

New Features:

  • Use feedback/ directory for user feedback submissions
  • Reference CAPABILITY-issue-tracking.yaml in integration code
  • See ReusableCapabilitiesArchitecture.md for complete specification

No API Changes: All Python APIs and CLI commands remain backward compatible.


Contributing

See the ROADMAP for planned features and implementation timeline.

For development guidance, see CLAUDE.md.

To submit feedback, see feedback/README.md.