貢獻指南

設定

設定 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 上更新