Skip to content

Commit a84b660

Browse files
contributing.mdx: how to ignore formatting revs
1 parent c5e4363 commit a84b660

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/source/contributing.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
# Contributors guidelines
22
... still under construction ... (feel free to propose materials, `bitsandbytes` is a community project)
33

4-
## Setup pre-commit hooks
4+
## Setup
5+
6+
### Setup pre-commit hooks
57
- Install pre-commit hooks with `pip install pre-commit`.
68
- Run `pre-commit autoupdate` once to configure the hooks.
79
- Re-run `pre-commit autoupdate` every time a new hook got added.
810

911
Now all the pre-commit hooks will be automatically run when you try to commit and if they introduce some changes, you need to re-add the changed files before being able to commit and push.
1012

13+
### Ignore formatting revs
14+
- Run `git config blame.ignoreRevsFile .git-blame-ignore-revs`. This will make it so that `git blame` is aware of commits that were logged to be solely formatting-related.
15+
1116
## Doc-string syntax
1217

1318
We're following NumPy doc-string conventions with the only notable difference being that we use Markdown instead of Rich text format (RTF) for markup within the doc-strings.

0 commit comments

Comments
 (0)