CHANGELOG.md

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

1.1.0 - 2024-12-31

Added

• New Python rule: error_handling.mdc - Exception patterns, custom exceptions, and API error responses
• New Python rule: logging.mdc - Structured logging with structlog, correlation IDs, and log levels
• New Python rule: security.mdc - Input validation, secrets management, authentication patterns
• CONTRIBUTING.md with guidelines for adding new rules
• Enhanced frontmatter for all rules with description, tags, and version fields

Changed

• Updated README.md with comprehensive documentation:
  • Installation instructions (copy, submodule, direct download)
  • Complete rule catalog with descriptions
  • Directory structure explanation
  • Rule relationships diagram
  • Usage guide
• Updated .cursor/rules/project.mdc to include software/ directory
• Standardized test directory naming to singular form (unit/, integration/) in python.mdc

Fixed

• Added missing imports in architecture.mdc:
  • ConfigDict and UUID imports in Entity example
  • ValueObject imports in Email and UserName examples
• Added missing ConfigDict import in fastapi_factory_utilities.mdc
• Improved email validation comment to recommend email-validator package

1.0.0 - 2024-12-01

Added

• Initial release with core cursor rules
• Python rules:
  • architecture.mdc - Clean/Hexagonal Architecture with Pydantic
  • fastapi_factory_utilities.mdc - FastAPI Factory Utilities framework
  • python.mdc - Core Python conventions
  • testing.mdc - pytest best practices
• Software rules:
  • architecture.mdc - Dependency Injection principles
  • testing.mdc - Testing fundamentals
• MIT License
• Basic README