Skip to content

Turn on formatting #31

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

Draft
sjavis wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Turn on formatting #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0de730
Add pre-commit instructions to README
sjavis May 21, 2025
8117e43
Add a pre-commit CI hook
sjavis May 21, 2025
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
8 changes: 8 additions & 0 deletions .github/workflows/testing.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,15 @@ on:
- '**.py'

jobs:
qa:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
- uses: pre-commit/action@v3.0.1

test:
needs: qa
runs-on: ubuntu-latest

strategy:
Expand Down
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,15 @@ The space for contribution is HUGE and OPEN! For instance:

Feel free to reach out, or directly fork, change, and create pull requests, or create new branches to contribute.

All contributed code should be formatted and linted with `ruff`. We use `pre-commit` to make sure all commits satisfy this requirement. To use this run:
```
pre-commit install
```
You can also manually perform the formatting using:
```
pre-commit run --all-files
```

### License

[MIT LICENSE](https://github.com/bioatmosphere/DEMENTpy/blob/master/LICENSE)
Expand Down