8000 Add section on bypassing Black formatting, and also how it works. · tecladocode/python-refresher@cf76e6d · GitHub
[go: up one dir, main page]

Skip to content

Commit cf76e6d

Browse files
committed
Add section on bypassing Black formatting, and also how it works.
1 parent 0dabdcf commit cf76e6d

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ pre-commit install
2323

2424
The first time you commit it may take a little longer than you'd hope, but subsequent commits will be quicker.
2525

26+
> Commits will **fail** if any files are formatted, but the files will still be formatted. This is so you are aware of the reformat and also so we don't accidentally reformat something we don't want to reformat.
27+
28+
If you want to run the commit without running the hook, do `git commit --no-verify`. This is highly discouraged, we should be aiming for consistent code, and using a formatter really helps us achieve that!
29+
2630
## allow_prereleases
2731

2832
The Pipfile has `allow_prereleases = "true"` because for Black this is required. Make sure when installing libraries that the latest stable version is used, but try to avoid using alpha and beta versions where possible.

0 commit comments

Comments
 (0)
0