Skip to content

CHANGELOG.md

Latest commit

 

History

History
101 lines (83 loc) · 7.01 KB

CHANGELOG.md

File metadata and controls

101 lines (83 loc) · 7.01 KB

Changelog

All notable changes to this project will be documented in this file. The format follows Keep a Changelog and the project adheres to Semantic Versioning.

[0.0.4] - 2025-12-08

Changed

  • Config resolution now starts from the lint/translate target path, so per-folder .fdsrc.yaml files are honored without changing the current working directory.
  • Translation command uses detected language objects safely, preventing crashes when language: auto is enabled.
  • DeepL provider applies a 5s default timeout and clearer API error messages to avoid CLI hangs during network issues.
  • Normalized line endings and trimmed trailing whitespace across fds_dev modules; added minimal module docstrings for tooling compatibility.
  • Added project .pylintrc tuned to existing Black/Ruff style to reduce lint noise while keeping structural checks in CI.

Testing

  • python -m pytest tests (110 passed)
  • python -m pylint fds_dev (10.00/10 with project config)

[0.0.3] - 2025-11-20

Added

  • Security Infrastructure: Comprehensive security baseline with SECURITY.md, vulnerability reporting process, and security checklist
  • Automated Dependency Updates: Dependabot configuration for weekly security updates (Python packages and GitHub Actions)
  • Code Quality Enforcement: Pre-commit hooks (black, ruff, isort, yamllint, detect-secrets) for automated quality checks
  • Coverage Enforcement: CI now enforces 70% minimum test coverage threshold
  • Type Checking: Integrated mypy for static type checking (strict mode, non-blocking)
  • Quick Start Examples: Added examples/basic_usage.py and examples/advanced_usage.py with 5+ practical patterns
  • Enterprise Documentation: Comprehensive deployment guide (docs/ENTERPRISE.md) covering self-hosted, CI/CD, and custom deployments
  • Growth Framework: Issue template for data-driven growth experiments with KPI tracking
  • Team Workflows: Documentation for GDPR, SOC2, HIPAA compliance and enterprise SLA information

Changed

  • README Restructure: Added 10-minute quickstart guide with step-by-step tutorial
  • Korean README Sync: Updated README_KR.md to match English version structure
  • Tool Configuration: Centralized pytest, coverage, mypy, black, isort, ruff configs in pyproject.toml
  • ASCII Icons: Replaced Unicode emojis with ASCII alternatives for cross-platform compatibility
  • YAML Standards: Added document start markers (---) and relaxed line-length rules for CI compatibility

Security

  • CODEOWNERS: Defined code ownership for automatic PR review assignment
  • Secret Scanning: Configured detect-secrets baseline for continuous secret scanning
  • Branch Protection: Documentation for required status checks and PR reviews
  • Security Checklist: Added pre-commit, code review, and release security checklists

Infrastructure

  • CI Enhancement: Extended workflow with coverage reporting, type checking, and multi-tool validation
  • Pre-commit Hooks: Automated formatting, linting, and security checks before each commit
  • Coverage Reporting: Detailed .coveragerc configuration with HTML and XML output

Documentation

  • Enterprise Guide: 7KB deployment architecture guide with Docker, Kubernetes, and monorepo patterns
  • Security Policy: SLA commitments, response times, and best practices for contributors
  • Examples Directory: Runnable code examples for basic and advanced usage patterns
  • Team Section: Added "For Teams & Enterprises" section to both READMEs

Performance

  • Quality Score Improvement: Repository quality score increased from 10% to 72.5% (+625%)
    • L0 Security: 1 → 8 (+700%)
    • L1 Engineering: 1 → 7 (+600%)
    • L2 Developer Experience: 2 → 8 (+300%)
    • L3 Growth: 0 → 6 (new)

[0.0.2] - 2025-11-19

Added

  • MarkdownParser now extracts inline links (file, anchor, and external) so lint rules can reason about documentation references.
  • BrokenLinkCheckRule verifies anchors, relative files, and (optionally) external URLs, with new .fdsrc.yaml toggles for enabled, check_external, and timeout.
  • README (English/Korean) now documents the optional broken link audits, CLI commands (fds lint, fds translate), and the broader “code-level internationalization” positioning, plus a dual-language About section.

Changed

  • LintRunner supports enabled: false or 'off' configurations so optional rules can be declared without running.
  • .fdsrc.yaml now documents how to configure the broken link rule without enabling it by default.
  • Internal reports (DOCUMENTATION_COMPLETE.md, FIX_SUMMARY.md, PROJECT_COMPLETION_REPORT.md, README_UPDATE_SUMMARY.md, test_ko.md) were removed from the repository and added to .gitignore.

Testing

  • Added parser coverage for link extraction and regression tests for the new BrokenLinkCheckRule (anchor, file, and external scenarios).
  • Mocked network calls in unit tests to keep the suite deterministic even when external checking is enabled.

[0.0.1] - 2025-11-19

Added

  • Initial fds CLI with the lint and translate commands, parallel lint execution, and persistent cache management via .fds_cache.json.
  • Translation pipeline that detects the source language, enforces .fdsrc.yaml rules, and fans out to DeepL, LibreTranslate, MyMemory, or the google-free backend with consistent result objects.
  • Language-aware Markdown parser, comment-preserving code parser, and translation quality tensor exported from fds_dev.i18n.
  • Configuration bootstrap (.fdsrc.yaml) plus opinionated rule presets for structure-aware linting.
  • Documentation set: docs/ARCHITECTURE.md, docs/TRANSLATION_ALGORITHM.md, docs/TROUBLESHOOTING.md, and the bilingual README pair.

Fixed

  • Corrected the TranslationResult import path and provided a guarded GoogleTranslator placeholder so unknown providers raise friendly errors instead of crashing.
  • Added exponential backoff retries to all HTTP translators to smooth over transient API failures.
  • Hardened output formatting and cache serialization so linting large documentation trees is deterministic.

Testing

  • Added 92 dedicated tests across tests/test_i18n_language_detector.py, tests/test_i18n_translator.py, tests/test_i18n_metacognition.py, and tests/test_i18n_code_parser.py, yielding 95% coverage with 100/105 tests green.
  • Captured regression data and fixtures for language detection, translation quality scoring, and lint runner behaviors.

Documentation

  • Rebuilt README.md with deployment badges, a feature tour, translation provider matrix, and support channels.
  • Authored Korean documentation (README_KR.md) to demonstrate the translation workflow.

Infrastructure

  • Set up .github/workflows/ci.yml for multi-version lint + pytest runs and .github/workflows/release.yml for trusted-publisher PyPI deployments and GitHub Releases.
  • Added PYPI_SETUP.md to document how to provision tokens, environments, and release tags.