貢獻

貢獻#

感謝您想辦法協助改進這個函式庫！請記住，貢獻的形式不只有撰寫錯誤修正程式碼。貢獻文件、針對錯誤開啟新的問題、詢問您覺得不清楚的地方，以及要求新功能，這些都是非常有價值的貢獻。

此函式庫的所有開發都在 GitHub 這裡進行。我們建議您使用 Conda 環境（或類似 venv 的其他虛擬環境）。

以下說明使用 Mamba，它是 conda 的一個非常快速的實作。

git clone <your fork>
cd ipympl
mamba env create --file dev-environment.yml
conda activate ipympl-dev
pre-commit install

安裝 Python 套件

pip install -e .

在開發擴充功能時，您需要使用筆記本/實驗室前端手動啟用擴充功能。對於實驗室，這可以透過以下命令完成

jupyter labextension develop --overwrite .
jlpm build

對於傳統筆記本，您需要執行

jupyter nbextension install --py --symlink --sys-prefix --overwrite ipympl
jupyter nbextension enable --py --sys-prefix ipympl

Typescript:

如果您使用 JupyterLab 進行開發，則可以在不同的終端機中同時監看來源目錄並執行 JupyterLab，以監看擴充功能來源中的變更並自動重建小工具。

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

變更後，請等待建置完成，然後重新整理您的瀏覽器，變更應該就會生效。

Python

如果您變更了 Python 程式碼，則需要重新啟動筆記本核心才會生效。

我們的文件是使用 Sphinx 從 docs 資料夾中的筆記本建置的。它包含 Markdown 檔案和 Jupyter 筆記本。

範例最好以 Jupyter 筆記本的形式撰寫。若要撰寫新的範例，請在 docs/examples 目錄中建立筆記本，並在 index.ipynb 檔案中的其中一個 toctree 下列出其路徑。當文件產生時，它們會由 myst-nb 呈現為靜態 html 頁面。

如果您已安裝所有開發人員相依性（請參閱上方），則可以使用在 docs 資料夾內執行的以下 make 命令重建文件

make html

然後您可以在瀏覽器中開啟 _build/index.html 檔案，您現在應該可以看到已呈現的文件。

或者，您可以使用 sphinx-autobuild 持續監看來源檔案的變更，並為您重建文件。Sphinx-autobuild 會自動安裝在您先前建立的開發環境中，因此您只需要執行

make watch

在 docs 資料夾內執行

幾秒鐘後，您的網頁瀏覽器應該會開啟文件。現在，每當您儲存檔案時，文件都會自動重新產生，而網頁也會為您重新整理！

使用 Git/GitHub 可能會令人困惑 (https://xkcd.com/1597)，因此如果您是 Git 的新手，您可能會發現使用像 GitHub Desktop 這樣的程式並遵循指南會很有幫助。

此外，歡迎在相關的 GitHub 問題上詢問協助/建議。

歡迎在任何 Github 問題上提出有關如何貢獻的問題。您也可以在 gitter 聊天室中提出較短的問題。