-
Notifications
You must be signed in to change notification settings - Fork 2
Modernize project structure and CI workflows #173
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Adopt python-repo-template best practices: update Makefile with comprehensive targets, switch to poetry-core, add black and flake8 for code quality, and move tests to the repo root. Overhaul GitHub Actions workflows (CI, Snyk, secrets scan, stale issues), improve dependabot config, and add cursor rules for development standards. Update README, LICENSE, and CHANGELOG to reflect new structure and tooling.
Added CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md, and changelog reference to README. Introduced GitHub issue and feature request templates, and updated the pull request template for clarity. Minor improvements to test files and documentation for better project maintainability and contributor guidance.
|
⏳ Code review in progress. Analyzing for code quality issues and best practices. Detailed findings will be posted upon completion. Using Amazon Q Developer for GitHubAmazon Q Developer1 is an AI-powered assistant that integrates directly into your GitHub workflow, enhancing your development process with intelligent features for code development, review, and transformation. Slash Commands
FeaturesAgentic Chat Code Review CustomizationYou can create project-specific rules for Amazon Q Developer to follow:
Example rule: FeedbackTo provide feedback on Amazon Q Developer, create an issue in the Amazon Q Developer public repository. For more detailed information, visit the Amazon Q for GitHub documentation. Footnotes
|
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall Assessment
This is an excellent modernization effort that brings the project up to current Python development standards. The changes demonstrate a comprehensive understanding of modern Python tooling and best practices.
✅ Strengths
Build System Modernization
- Successfully migrated from setuptools to poetry-core for cleaner, more modern builds
- Proper Poetry configuration with well-organized dependency groups
- Updated Python version support to include 3.10-3.13
Development Workflow Improvements
- Comprehensive Makefile with intuitive targets (
setup-init,pre-commit, etc.) - Added black for code formatting and improved linting setup
- Moved tests to repository root following modern conventions
CI/CD Enhancements
- Improved GitHub Actions workflows with better path filtering
- Added Snyk vulnerability scanning for enhanced security
- Enhanced dependabot configuration (removed redundant pip ecosystem)
Documentation & Project Structure
- Added comprehensive community files (CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md)
- Updated README with modern badges and clear installation instructions
- Added cursor rules for development workflow documentation
⚠️ Issues to Address
Security Concerns
- Command injection vulnerability in
saml2aws_helper.py(high priority) - Snyk action using
@masterinstead of pinned version
Minor Improvements
- Missing Python 3.10 classifier in pyproject.toml
- Makefile dependency inconsistency for lint-python target
- CI concurrency configuration could be optimized
- Issue template links could be project-specific
🎯 Recommendation
Approve with minor fixes. The security vulnerability should be addressed before merging, but the overall modernization is well-executed and significantly improves the project's maintainability and developer experience.
The migration to Poetry, comprehensive Makefile, and enhanced CI/CD pipeline represent substantial improvements that will benefit long-term maintenance and contributor onboarding.
Cleaned up formatting by removing trailing spaces from the default values in the bug report issue template.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #173 +/- ##
==========================================
- Coverage 98.92% 95.45% -3.47%
==========================================
Files 8 4 -4
Lines 926 220 -706
==========================================
- Hits 916 210 -706
Misses 10 10 🚀 New features to boost your workflow:
|
Co-authored-by: amazon-q-developer[bot] <208079219+amazon-q-developer[bot]@users.noreply.github.com>
Co-authored-by: amazon-q-developer[bot] <208079219+amazon-q-developer[bot]@users.noreply.github.com>
Adopt python-repo-template best practices: update Makefile with comprehensive targets, switch to poetry-core, add black and flake8 for code quality, and move tests to the repo root. Overhaul GitHub Actions workflows (CI, Snyk, secrets scan, stale issues), improve dependabot config, and add cursor rules for development standards. Update README, LICENSE, and CHANGELOG to reflect new structure and tooling.