README的最后一部分是如果您想通过代码贡献来参与其中。

开发安装

要使用开发模式安装，请使用以下命令

$ git clone git+https://github.com/biopragmatics/debio.git
$ cd debio
$ pip install -e .

🥼 测试

在克隆存储库并使用pip install tox安装tox后，可以使用以下方式重复运行tests/文件夹中的单元测试

$ tox

此外，这些测试在每次提交时都会自动重新运行，由GitHub Action触发。

📖 构建文档

可以使用以下方式在本地构建文档

$ git clone git+https://github.com/biopragmatics/debio.git
$ cd debio
$ tox -e docs
$ open docs/build/html/index.html

文档会自动安装包以及setup.cfg中指定的docs额外部分。可以在其中添加texext等插件。此外，它们还需要添加到docs/source/conf.py中的extensions列表中。

📦 制作发布版本

在开发模式下安装包并使用pip install tox安装tox后，制作新发布版本的命令包含在tox.ini的finish环境中。请在shell中运行以下命令

$ tox -e finish

此脚本执行以下操作

1. 使用Bump2Version将setup.cfg、src/debio/version.py和docs/source/conf.py中的版本号更改为不带-dev后缀
2. 使用build将代码打包成tar存档和wheel格式
3. 使用twine上传到PyPI。请确保有一个配置好的.pypirc文件，以避免在此步骤中需要手动输入
4. 推送到GitHub。您需要创建一个与版本提升的提交相对应的发布版本
5. 将版本提升到下一个补丁。如果您进行了大的更改并希望通过次要版本提升版本，可以在之后使用tox -e bumpversion minor