Refactoring complete #8
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 pull request includes various improvements and refactoring for the bot application, focusing on code quality, documentation, and database operations. The most important changes include the addition of a GitHub Actions workflow for code quality checks, updates to the
README.mdfile, and significant refactoring of database-related modules.Improvements to Code Quality and Documentation:
.github/workflows/python-poetry-code-quality.yml: Added a GitHub Actions workflow to perform code quality checks using pylint and run tests using pytest.README.md: Updated the badge link to reflect the new code quality workflow and improved the documentation structure. [1] [2]Refactoring and Enhancements to Database Modules:
bot/database/database.py: Refactored theDatabaseclass to improve code readability and added comprehensive docstrings. Introduced a newfix_pathmethod to handle database path creation.bot/database/order.py,bot/database/product.py,bot/database/user.py: Converted theOrder,Product, andUserclasses to use thedataclassdecorator and added detailed docstrings. [1] [2] [3]General Code Improvements:
bot/__main__.py: Added a module-level docstring and made minor improvements to the code for better readability. [1] [2]bot/database/__init__.py: Added a module-level docstring and updated the__all__list to use double quotes for consistency.