贡献者指南
… 仍在建设中 … (欢迎提出材料,bitsandbytes
是一个社区项目)
设置
设置预提交钩子
- 使用
pip install pre-commit
安装预提交钩子。 - 运行一次
pre-commit install
以安装钩子,以便在每次提交时运行它们。 - 如果钩子引入了更改,则可以使用
git diff
查看它们。检查它们,如果一切正常,则git add
它们,然后重新执行提交前操作,现在应该可以通过了。 - 如果您想手动触发钩子,可以执行
pre-commit run --all-files
现在,当您尝试提交时,所有预提交钩子都会自动运行,如果它们引入了一些更改,则需要在能够提交和推送之前重新添加已更改的文件。
忽略格式化版本
- 运行
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