8000 add tl;dr about failed quality jobs to pre-commit docs by clmould · Pull Request #3665 · ukaea/PROCESS · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

add tl;dr about failed quality jobs to pre-commit docs #3665

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

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

add tl;dr about failed quality jobs to pre-commit docs #3665

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8a3f1d
correct settings file extension in docs
clmould May 15, 2025
9a7a2da
Add tldr to pre-commit docs for if the quality job fails
clmould May 16, 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
7 changes: 6 additions & 1 deletion documentation/proc-pages/development/pre-commit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Pre-commit

!!! Info "TL;DR: the quality job fails"
If the quality job fails, run pre-commit using `pre-commit run --all-files` and commit the file changes to your branch. If this doesn't solve
the problem then see below for more details.


Pre-commit is PROCESS' way of ensuring all code pushed to our repository is of a certain quality
and style. One common style ensures PROCESS can be easily navigated and understood by all users. It
also reduces the "diffs" when reviewing code changes as often small style changes (such as the
Expand Down Expand Up @@ -87,7 +92,7 @@ your commits pass through pre-commit, then these jobs should not fail as your co
Although not required, the `ruff` VSCode extension will ensure that all the Python files you save
will be ruff-compliant and, as such, won't need to modified by pre-commit.

Open or create the file `.vscode/settings.sh` and add/modify the following settings:
Open or create the file `.vscode/settings.json` and add/modify the following settings:
```json
{
"[python]": {
Expand Down
Loading
0