chore: prepare 2.4.0 project and release workflow refresh#13
Merged
Conversation
…d trusted publishing
There was a problem hiding this comment.
Pull request overview
This PR prepares the 2.4.0 release by modernizing the project's infrastructure, documentation, and CI/CD pipeline. It updates the project from a minimal setup to a more comprehensive open-source project structure with proper community health files, automated testing gates, and trusted publishing workflows.
Changes:
- Modernized CI/CD with test-gated builds and trusted PyPI publishing
- Added comprehensive community health files (contributing guide, issue/PR templates, pre-commit hooks, changelog)
- Refreshed project metadata and documentation (pyproject.toml, README, author attribution)
Reviewed changes
Copilot reviewed 10 out of 13 changed files in this pull request and generated 13 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Updated metadata, dynamic versioning, Python 3.8+ support, wheel includes for type stubs |
| Cargo.toml | Version bump to 2.4.0, edition update to 2024 |
| Cargo.lock | Automatic version bump update |
| py.typed | Added PEP 561 typing marker file |
| README.md | Complete rewrite with features, examples, development setup, and support sections |
| CHANGELOG.md | New comprehensive changelog following Keep a Changelog format |
| CONTRIBUTING.md | New contributor guide with setup and workflow instructions |
| .pre-commit-config.yaml | New pre-commit configuration for code quality automation |
| .gitignore | Streamlined to cover Rust/Python artifacts and common IDE files |
| .github/workflows/CI.yml | Refactored to test-gated multi-stage flow with trusted publishing |
| .github/PULL_REQUEST_TEMPLATE.md | New PR template with validation checklist |
| .github/ISSUE_TEMPLATE/bug_report.yml | New structured bug report form |
| .github/ISSUE_TEMPLATE/feature_request.yml | New structured feature request form |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Prepare the 2.4.0 release by modernizing project metadata, CI/CD, and contributor/project documentation.
Changes
pyproject.toml,py.typed,.gitignore,.pre-commit-config.yaml).Checklist
cargo test)cargo fmtandruff format)cargo clippy)