feat: add production-level enhancements #3
Merged
Conversation
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
This commit elevates the project to a production-ready standard by integrating a suite of professional software engineering practices. - **Code Quality Tools:** - `black` has been added for automated code formatting. - `flake8` has been added for linting, with a `.flake8` configuration file. - The entire codebase has been formatted and linted. - **Continuous Integration (CI):** - A GitHub Actions workflow has been added at `.github/workflows/ci.yml`. - The CI pipeline automatically installs dependencies, runs linters, checks formatting, and executes the full `pytest` suite across multiple Python versions. - **Contributor Experience:** - A `CONTRIBUTING.md` file has been added to provide clear instructions for new developers on how to set up the project and contribute.
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.
This commit elevates the project to a production-ready standard by integrating a suite of professional software engineering practices.
Code Quality Tools:
blackhas been added for automated code formatting.flake8has been added for linting, with a.flake8configuration file.Continuous Integration (CI):
.github/workflows/ci.yml.pytestsuite across multiple Python versions.Contributor Experience:
CONTRIBUTING.mdfile has been added to provide clear instructions for new developers on how to set up the project and contribute.