Skip to content

Exclude README from pre-commit globally#11

Merged
williamFalcon merged 1 commit into
mainfrom
exclude-readme-from-precommit
Jul 28, 2025
Merged

Exclude README from pre-commit globally#11
williamFalcon merged 1 commit into
mainfrom
exclude-readme-from-precommit

Conversation

@justusschock
Copy link
Copy Markdown
Member

@justusschock justusschock commented Jul 28, 2025

Before submitting
  • Was this discussed/agreed via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure to update the docs?
  • Did you write any new necessary tests?

What does this PR do?

Globally exclude README from all pre-commit hooks and not hook-by-hook

Before:

pre-commit run --all-files
fix end of files.........................................................Failed
- hook id: end-of-file-fixer
- exit code: 1
- files were modified by this hook

Fixing README.md

trim trailing whitespace.................................................Passed
check for case conflicts.................................................Passed
check yaml...............................................................Passed
check toml...............................................................Passed
check json...........................................(no files to check)Skipped
check for added large files..............................................Passed
check docstring is first.................................................Passed
detect private key.......................................................Passed
type annotations not comments............................................Passed
codespell................................................................Passed
prettier.................................................................Passed
ruff (legacy alias)......................................................Passed
ruff format..............................................................Passed
ruff (legacy alias)......................................................Passed

After:

⚡ exclude-readme-from-precommit ~/litAI pre-commit run --all-files             
fix end of files.........................................................Passed
trim trailing whitespace.................................................Passed
check for case conflicts.................................................Passed
check yaml...............................................................Passed
check toml...............................................................Passed
check json...........................................(no files to check)Skipped
check for added large files..............................................Passed
check docstring is first.................................................Passed
detect private key.......................................................Passed
type annotations not comments............................................Passed
codespell................................................................Passed
prettier.................................................................Passed
ruff (legacy alias)......................................................Passed
ruff format..............................................................Passed
ruff (legacy alias)......................................................Passed

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in GitHub issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

@justusschock justusschock marked this pull request as ready for review July 28, 2025 13:18
@justusschock justusschock force-pushed the exclude-readme-from-precommit branch from 709549c to c0643bb Compare July 28, 2025 13:18
@justusschock justusschock changed the title Update .pre-commit-config.yaml Exclude README from pre-commit globally Jul 28, 2025
@justusschock justusschock enabled auto-merge (squash) July 28, 2025 13:20
@williamFalcon williamFalcon disabled auto-merge July 28, 2025 13:30
@williamFalcon williamFalcon merged commit 90026ec into main Jul 28, 2025
29 checks passed
@williamFalcon williamFalcon deleted the exclude-readme-from-precommit branch July 28, 2025 13:30
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