-
Notifications
You must be signed in to change notification settings - Fork 638
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add mention of pre-commit to contributing
- Loading branch information
1 parent
47cc3e9
commit c26645b
Showing
1 changed file
with
7 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,13 @@ | ||
# Contributors guidelines | ||
... stil under construction ... (feel free to propose materials, `bitsandbytes` is a community project) | ||
|
||
# Setup pre-commit hooks | ||
- Install pre-commit hooks with `pip install pre-commit`. | ||
- Run `pre-commit autoupdate` once to configure the hooks. | ||
- Re-run `pre-commit autoupdate` every time a new hook got added. | ||
|
||
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. | ||
|
||
## Documentation | ||
- [guideline for documentation syntax](https://github.com/huggingface/doc-builder#readme) | ||
- images shall be uploaded via PR in the `bitsandbytes/` directory [here](https://huggingface.co/datasets/huggingface/documentation-images) |