Contributors guidelines

… still under construction … (feel free to propose materials, bitsandbytes is a community project)

Setup

Setup pre-commit hooks

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.

Ignore formatting revs

Doc-string syntax

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.

Please see the existing documentation to see how to generate autodocs.

Documentation