贡献

贡献#

感谢您考虑为改进此库做出贡献！请记住，贡献的形式多种多样，不仅仅是编写错误修复。为文档做出贡献、为错误打开新的 issue、询问您不清楚的地方以及请求新功能，都是非常有价值的贡献。

此库的所有开发都在 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 .

在开发扩展时，您需要使用 notebook/lab 前端手动启用您的扩展。对于 lab，可以通过以下命令完成

jupyter labextension develop --overwrite .
jlpm build

对于经典 notebook，您需要运行

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 代码进行了更改，则需要重新启动 notebook 内核才能使其生效。

我们的文档是使用 Sphinx 从 docs 文件夹中的 notebook 构建的。它包含 Markdown 文件和 Jupyter notebook。

示例最好编写为 Jupyter notebook。要编写新示例，请在 docs/examples 目录中创建一个 notebook，并在 index.ipynb 文件中的 toctrees 之一下列出其路径。生成文档时，它们将由 myst-nb 呈现为静态 html 页面。

如果您已安装所有开发人员依赖项（请参阅上面），则可以使用以下 make 命令从 docs 文件夹内重新构建文档

make html

然后，您可以在浏览器中打开 _build/index.html 文件，现在您应该可以看到呈现的文档。

或者，您可以使用 sphinx-autobuild 来持续监视源文件的更改并为您重新构建文档。Sphinx-autobuild 将自动安装在您之前创建的开发环境中，因此您只需运行

make watch

从 docs 文件夹内部

几秒钟后，您的 Web 浏览器应该会打开文档。现在，每当您保存文件时，文档将自动重新生成，网页将为您刷新！

使用 Git/GitHub 可能会令人困惑 (https://xkcd.com/1597)，因此，如果您是 Git 新手，您可能会发现使用类似 GitHub Desktop 的程序并遵循指南会有所帮助。

также не стесняйтесь спрашивать помощь/совет в соответствующем GitHub issue.

欢迎在任何 Github Issue 上提出有关如何贡献的问题。您也可以在 gitter 聊天室中提出更简短的问题。