Skip to content

Conversation

@FlysonBot
Copy link
Owner

@FlysonBot FlysonBot commented Dec 4, 2024

Add scripts for one-click install and uninstall on all OS, along with an instruction on how to use them. Add tests for the main package, along with some minor refactoring.

Summary by Sourcery

Introduce one-click install and uninstall scripts for all operating systems, refactor the MainUI and DataDisplayMenu classes, and add comprehensive unit tests for main components. Update CI workflow to use 'pull_request_target' and add documentation for installation and usage.

New Features:

  • Add one-click install and uninstall scripts for all operating systems.

Enhancements:

  • Refactor the MainUI class to remove the singleton pattern and improve code clarity.
  • Refactor the DataDisplayMenu class to use ABC for abstract methods.

CI:

  • Change the GitHub Actions workflow to use 'pull_request_target' instead of 'pull_request' for triggering builds.

Documentation:

  • Add a README file in the examples directory with instructions for running the install scripts and using Google Colab.

Tests:

  • Add unit tests for the MainUI, GameHistoryManager, GameController, and game storage functionalities.

@FlysonBot FlysonBot self-assigned this Dec 4, 2024
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @FlysonBot - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding documentation about required package managers (apt/brew/winget) in the installation script README to help users troubleshoot installation issues.
Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟡 Security: 1 issue found
  • 🟡 Testing: 3 issues found
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@FlysonBot FlysonBot merged commit bcc58a1 into main Dec 4, 2024
6 checks passed
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.

2 participants