You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/contributing.mdx
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,18 @@
1
1
# Contributors guidelines
2
2
... still under construction ... (feel free to propose materials, `bitsandbytes` is a community project)
3
3
4
-
## Setup pre-commit hooks
4
+
## Setup
5
+
6
+
### Setup pre-commit hooks
5
7
- Install pre-commit hooks with `pip install pre-commit`.
6
8
- Run `pre-commit autoupdate` once to configure the hooks.
7
9
- Re-run `pre-commit autoupdate` every time a new hook got added.
8
10
9
11
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.
10
12
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
+
11
16
## Doc-string syntax
12
17
13
18
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