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

Add pre-commit config with pre-commit-hooks #3283

Merged
merged 20 commits into from
Jun 11, 2024
Merged
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
93dc844
Add pre-commit config with pre-commit-hooks
weiji14 Jun 4, 2024
0d17730
Add pre-commit CI badge to main README.md
weiji14 Jun 4, 2024
8176a18
Mention pre-commit autofix command in doc/contributing.md
weiji14 Jun 4, 2024
4ae3ba5
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jun 4, 2024
c23f776
Add .pre-commit-config.yaml to MAINIFEST.in
weiji14 Jun 4, 2024
ce6d457
Add forbid-crlf, remove-crlf and chmod hooks, remove from GitHub Actions
weiji14 Jun 4, 2024
5a01ad6
Remove chmod pre-commit hook and use GitHub Action method again
weiji14 Jun 4, 2024
a444d33
Add `pre-commit run --all-files` to `make format`
weiji14 Jun 9, 2024
b3eee6f
Mention pre-commit autofix command in Pull Request template
weiji14 Jun 9, 2024
d937cac
Revert "Add pre-commit CI badge to main README.md"
weiji14 Jun 11, 2024
0f09fb6
Revert "Mention pre-commit autofix command in doc/contributing.md"
weiji14 Jun 11, 2024
386ad8e
Revert "Mention pre-commit autofix command in Pull Request template"
weiji14 Jun 11, 2024
25652fc
Add pre-commit to Style Checks and format-command workflows
weiji14 Jun 11, 2024
f505a99
[ci skip] Fix end-of-line in style_checks.yaml
weiji14 Jun 11, 2024
7b67296
Remove pre-commit.ci config from .pre-commit-config.yaml
weiji14 Jun 11, 2024
533dc4f
Revert "Remove chmod pre-commit hook and use GitHub Action method again"
weiji14 Jun 11, 2024
10ccc9b
Temporarily change requirements.txt permissions to 744
weiji14 Jun 11, 2024
70414ac
Revert "Temporarily change requirements.txt permissions to 744"
weiji14 Jun 11, 2024
c0e6930
Update note on style_checks.yaml to mention ruff+pre-commit is ran
weiji14 Jun 11, 2024
b606f7f
Mention that pre-commit is used to enforce LF ending and 644 permissions
weiji14 Jun 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Mention that pre-commit is used to enforce LF ending and 644 permissions
  • Loading branch information
weiji14 committed Jun 11, 2024
commit b606f7f014744b51c003bb8f93c720b3de8e8875
4 changes: 2 additions & 2 deletions doc/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -481,8 +481,8 @@ the code yourself. Before committing, run it to automatically format your code:
make format
```

For consistency, we also use UNIX-style line endings (`\n`) and file permission
644 (`-rw-r--r--`) throughout the whole project.
For consistency, we also use `pre-commit` hooks to enforce UNIX-style line endings
(`\n`) and file permission 644 (`-rw-r--r--`) throughout the whole project.
Don't worry if you forget to do it. Our continuous integration systems will
warn us and you can make a new commit with the formatted code.
Even better, you can just write `/format` in the first line of any comment in a
Expand Down