贡献者指南

… 仍在建设中 … (欢迎提出建议, bitsandbytes 是一个社区项目)

设置

设置 pre-commit 钩子

• 使用 pip install pre-commit 安装 pre-commit 钩子。
• 运行 pre-commit install 一次以安装钩子，这样它们将在每次提交时运行。
• 如果钩子引入了更改，它们将通过 git diff 可见。检查它们，如果一切正常，则 git add 它们，然后重新执行之前的提交，现在应该可以通过了。
• 如果想手动触发钩子，可以执行 pre-commit run --all-files

现在，当您尝试提交时，所有 pre-commit 钩子将自动运行，如果它们引入了一些更改，您需要重新添加更改的文件，然后才能提交和推送。

忽略格式化修订

• 运行 git config blame.ignoreRevsFile .git-blame-ignore-revs。这将使 git blame 能够识别仅与格式相关的提交。

文档字符串语法

我们遵循 NumPy 文档字符串约定，唯一的显著区别是我们使用 Markdown 而不是富文本格式 (RTF) 在文档字符串中进行标记。

请参阅现有文档，了解如何生成自动文档。

文档

• 文档语法指南
• 图片应通过 PR 上传到 bitsandbytes/ 目录 此处
• 在发布到 PR 的链接中查找每个 PR 的文档构建，例如 https://moon-ci-docs.huggingface.co/docs/bitsandbytes/pr_1012/en/introduction

< > 在 GitHub 上更新