開發者頁面¶
此頁面說明如何透過提交修補程式、統計測試、新模型或範例來貢獻statsmodels 的開發。
statsmodels 是在 Github 上使用 Git 版本控制系統開發的。
提交錯誤報告¶
包含一個簡短、獨立的程式碼片段,可重現問題
指定使用的 statsmodels 版本。您可以使用
sm.version.full_version
來執行此操作如果問題看起來涉及其他相依性,也請包含
sm.show_versions()
的輸出
修改程式碼¶
首先,請參閱 使用 statsmodels 程式碼 章節,以了解 git 版本控制系統的簡介。
要接受 Pull Request,您必須符合以下要求。這對維護和發布軟體(作為共同努力)的工作非常有幫助。
一個分支。一個功能。 分支很便宜,github 讓您只需點擊幾下即可輕鬆合併和刪除分支。在開發功能時,如果可能,請避免將一堆不相關的變更混在一起。這有助於我們在準備發布時追蹤發生了哪些變更。
提交訊息應清晰簡潔。這表示主旨行少於 80 個字元,並且如果需要,後跟一個空白行,然後是提交訊息內文。我們有一個 非正式的提交格式標準,我們盡力遵守。您可以透過
git log --oneline -n 10
來查看實際情況。如果您的提交參考或關閉了特定的問題,您可以透過在 提交訊息 中提及來關閉它。(對於維護者:這些建議也適用於合併提交訊息。這些部分是發行說明的記錄。)程式碼提交必須始終包含測試。請參閱我們關於 測試 的筆記。
每個函數、類別、方法和屬性都需要使用 docstring 來記錄。我們遵循 numpy docstring 標準。
如果您要新增功能,您需要透過編輯(或建立)
docs/source
中的適當檔案來將其新增至文件。請確保您的文件變更可以正確剖析。變更為頂層
docs/
目錄並輸入make clean make html
檢查建置輸出是否沒有因您的變更而產生的任何警告。
產生文件需要額外的相依性,詳細資訊請參閱
docs/README.md
。盡可能遵循 PEP8 樣式指南。透過執行
LINT=true ./lint.sh
來檢查您的程式碼。透過執行
git diff upstream/main
來比較您的變更與 main 中的內容。最後,請將您的變更新增至發行說明。開啟具有下一個版本號碼的
docs/source/release/versionX.X.rst
檔案,並將您的變更新增至適當的章節。
如何提交 Pull Request¶
所以您想要向 statsmodels 提交修補程式,但不太熟悉 github?以下是您需要採取的步驟。
Fork Github 上的 statsmodels 儲存庫。
建立新的功能分支。每個分支必須是獨立的,具有單一的新功能或錯誤修復。
請確保測試套件通過。這包括在 Python 3 上進行測試。最簡單的方法是提出 Pull Request 並讓機器人為您檢查。這可能會很慢,如果您不確定修復或增強功能,最好在本地執行 pytest。
Pull Request 在被接受到程式碼庫之前會經過徹底的審查。如果您的 Pull Request 過期,請將您的 Pull Request 基於中央儲存庫中的最新版本進行重新定基。
郵件列表¶
有關開發的對話會在 statsmodels 郵件列表上進行。
授權條款¶
statsmodels 是在 修改後的 (3 條款) BSD 授權下發布的。