貢獻指南

我們非常歡迎您的貢獻！如果您對新的教學文件有任何想法或提案，請開啟 issue 並提供大綱。

即使英文不是您的母語，或者您只能提出粗略的草稿，也請別擔心。開源是一個社群的努力。盡力而為 – 我們會協助修正問題。

圖片和真實生活資料能使文字更引人入勝且更有力，但請務必確認您使用的素材已獲得適當授權且可供使用。同樣地，即使是美術作品的粗略想法，也可以由其他人潤飾。

NumPy 教學文件是精選的 MyST-NB notebooks 集合。這些 notebooks 用於產生靜態網站，並且可以使用 Jupytext 在 Jupyter 中以 notebooks 形式開啟。

注意： 您應該使用 CommonMark markdown 儲存格。Jupyter 僅渲染 CommonMark。

為何選擇 Jupyter Notebooks？

本儲存庫選擇 Jupyter Notebook 而非主要 NumPy 文件中使用的常用格式 (reStructuredText) 有兩個原因：

• Jupyter notebooks 是用於交流科學資訊的常用格式。

• Jupyter notebooks 可以在 Binder 中啟動，以便使用者可以與教學文件互動

• rST 可能會對某些原本非常有興趣貢獻教學文件的人構成障礙。

注意

您可能會注意到我們的內容採用 markdown 格式（.md 檔案）。我們會審查並託管 MyST-NB 格式的 notebooks。我們接受 Jupyter notebooks（.ipynb）和 MyST-NB notebooks（.md）。如果您想將您的 .ipynb 與您的 .md 檔案同步，請依照配對教學文件。

新增您自己的教學文件

如果您有自己的 Jupyter notebook 形式的教學文件（.ipynb 檔案），並且想要嘗試將其新增到儲存庫中，請依照以下步驟操作。

建立 issue

前往 numpy/numpy-tutorials#issues 並建立一個新的 issue，其中包含您的提案。請盡可能詳細說明您想要撰寫的內容類型（教學文件、操作指南）以及您計劃涵蓋的內容。我們會盡快回覆並提供評論（如果適用）。

查看我們建議的範本

您可以使用此範本使您的內容與我們現有的教學文件保持一致

• 學習撰寫 NumPy 教學文件

上傳您的內容

請記住在上傳 notebook 之前清除所有輸出。

Fork 這個儲存庫（如果您之前沒有 fork 過）。

在您自己的 fork 中，為您的內容建立一個新的分支。

將您的 notebook 新增到 content/ 目錄中。


更新 environment.yml 檔案，加入您的教學文件的依賴套件（僅當您新增了新的依賴套件時）。

更新此 README.md 以包含您的新條目。

建立一個 pull request。 請確保選取「Allow edits and access to secrets by maintainers」選項，以便我們可以正確審查您的提交內容。


🎉 等待審查！

有關 GitHub 及其工作流程的更多資訊，您可以參閱 此文件。