Skip to content
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

Feature/more pre commit #65

Merged
merged 3 commits into from
Nov 14, 2024
Merged

Feature/more pre commit #65

merged 3 commits into from
Nov 14, 2024

Conversation

blooop
Copy link
Owner

@blooop blooop commented Nov 14, 2024

Summary by Sourcery

Enhance the pre-commit configuration by adding new hooks for various checks and fix a typo in the documentation.

Enhancements:

  • Add additional pre-commit hooks for checking executables, shebangs, test naming, private keys, TOML, and XML files.

Documentation:

  • Fix a typo in the README.md file.

Copy link

sourcery-ai bot commented Nov 14, 2024

Reviewer's Guide by Sourcery

This PR enhances the pre-commit configuration by adding several new hooks for code quality checks and introducing a spell checker. The changes primarily focus on expanding the validation coverage of the codebase through additional pre-commit hooks and fixing a typo in the documentation.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added new pre-commit hooks for enhanced code quality checks
  • Added executable and shebang validation hooks
  • Added test naming convention check
  • Added private key detection
  • Added TOML and XML file validation
  • Enabled debug statements check
  • Uncommented debug-statements hook
.pre-commit-config.yaml
Integrated codespell for spell checking
  • Added codespell hook with write-changes option
  • Configured exclusions for specific file types
  • Added note about version 2.3.0 and assertIn issue
.pre-commit-config.yaml
Fixed documentation typo
  • Corrected 'likey' to 'likely' in troubleshooting section
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@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 @blooop - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 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.

@blooop blooop merged commit 7eaec9c into main Nov 14, 2024
7 checks passed
@blooop blooop deleted the feature/more_pre-commit branch November 14, 2024 18:06
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.

1 participant