Skip to content

feat: Comprehensive template modernization, infrastructure updates, and testing standardization#2

Merged
markurtz merged 0 commit into
mainfrom
feature/release-updates
May 13, 2026
Merged

feat: Comprehensive template modernization, infrastructure updates, and testing standardization#2
markurtz merged 0 commit into
mainfrom
feature/release-updates

Conversation

@markurtz
Copy link
Copy Markdown
Owner

Description

This PR introduces a comprehensive modernization of the repository, bringing its infrastructure, testing suite, and documentation up to the latest standards. It incorporates gitversioned for automated versioning and updates the build system to utilize hatch and uv with modern dependency management.

Key changes include:

  • Build & Dependencies: Migrated to hatch and uv for dependency management, adopting modern pyproject.toml standards and dependency-groups.
  • Core Infrastructure: Standardized core source modules (__init__.py, __main__.py, logging.py, settings.py, compat.py) with strict typing, PEP-8 compliance, and OpenTelemetry compatibility.
  • Testing: Completely restructured the tests/ directory into cleanly separated unit, integration, and e2e suites. Implemented rigorous parameterized fixtures, removed redundant boilerplate, and ensured full public API test coverage.
  • Documentation: Modernized the MkDocs Material documentation site. Fixed visual rendering bugs (e.g., broken grid layouts), moved technical guides to a dedicated guides/ directory, and standardized documentation within src/ using proper reST docstrings.
  • Versioning: Integrated gitversioned to handle dynamic project versioning automatically across all template derivatives.
  • Workflows & Bootstrapping: Updated GitHub Actions CI/CD workflows and refined the scripts/bootstrap.sh utility to properly inject organization and project name placeholders for new downstream projects.

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📝 Documentation update (changes to README.md, SUPPORT.md, docstrings, etc.)
  • 🛠️ Maintenance/Refactoring (non-breaking change that improves code structure or quality)

Test Plan

Automated test suites (Unit, Integration, and E2E) have been overhauled and executed to ensure functional parity and strict quality standards:

  • Unit Tests: hatch run test:unit to verify the internal logic of core modules without side effects.
  • Integration Tests: hatch run test:integration to validate the functional pathways and configurations across modules.
  • E2E Tests: hatch run test:e2e to verify the CLI execution (python -m project_name) and end-to-end logging functionality.
  • Linting & Formatting: Ran pre-commit run --all-files and hatch run lint:check to ensure no new warnings or type errors (MyPy) exist.
  • Docs Build: Validated documentation rendering and links via hatch run docs:build.

Related Issues

  • Fixes #

Screenshots / Visuals (if applicable)

N/A

Use of AI

  • Includes AI-assisted code completion
  • Includes code generated by an AI application
  • Includes AI-generated tests (NOTE: AI written tests should have a docstring that includes ## WRITTEN BY AI ##)

Checklist

Important

Please review and complete this checklist before submitting your PR. This helps our maintainers process your contribution faster and ensures it meets the quality standards of project_name.

  • "I certify that all code in this PR is my own, except as noted below."
  • I have read the CONTRIBUTING.md guide.
  • My code follows the established style guidelines of project_name.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings or errors.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.

@markurtz markurtz requested a review from Copilot May 13, 2026 20:14
@markurtz markurtz self-assigned this May 13, 2026
@markurtz markurtz changed the title Feature/release updates feat: Comprehensive template modernization, infrastructure updates, and testing standardization May 13, 2026
@markurtz markurtz merged commit f0b9a39 into main May 13, 2026
1 check failed
@markurtz markurtz deleted the feature/release-updates branch May 13, 2026 20:16
@markurtz markurtz review requested due to automatic review settings May 13, 2026 20:35
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.

1 participant