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

开发安装

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

$ git clone git+https://github.com/y0-causal-inference/eliater.git
$ cd eliater
$ pip install -e .

🥼 测试

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

$ tox

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

📖 构建文档

可以使用以下命令在本地构建文档

$ git clone git+https://github.com/y0-causal-inference/eliater.git
$ cd eliater
$ tox -e docs
$ open docs/build/html/index.html

文档会自动安装包以及 setup.cfg 中指定的 docs 额外内容。可以在此处添加如 texext 之类的 sphinx 插件。另外，还需要将它们添加到 docs/source/conf.py 中的 extensions 列表中。

📦 制作发行版

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

$ tox -e finish

此脚本执行以下操作

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