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.

Sign up for GitHub

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

Adds pre-commit for auto ruff before commit #40

Merged
merged 3 commits into from
Dec 4, 2024
Merged

Adds pre-commit for auto ruff before commit #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
412c69b
Adds pre-commit for auto ruff before commit
sherjeelshabih Dec 2, 2024
b3b1e21
Adds pre-commit instructions to Readme
sherjeelshabih Dec 2, 2024
ebb7e84
Update README.md
sherjeelshabih Dec 2, 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
9 changes: 9 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version.
rev: v0.8.1
hooks:
# Run the linter.
- id: ruff
# Run the formatter.
- id: ruff-format
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,14 @@ To integrate this plugin with your NOMAD installation:

2. For more detailed installation instructions, visit our [docs for NOMAD plugins](https://nomad-lab.eu/prod/v1/staging/docs/plugins/plugins.html).

## Developers

It's nice to not miss a ruff format before pushing your commits. To set up pre-commit hook:
```console
pip install pre-commit
pre-commit install
```

### Acknowledgments
Special thanks to Jinzhao Li and all contributors who have made this project possible.

Expand Down