贡献

我们欢迎您的贡献，并且非常感谢您的参与！每一点帮助都非常重要，并且您的贡献将始终得到认可。

您可以通过多种方式进行贡献：

贡献类型

报告错误

请在 https://github.com/manujosephv/pytorch_tabular/issues 报告错误。

如果您报告错误，请包含以下信息：

• 您的操作系统名称和版本。
• 任何可能有助于故障排除的本地设置细节。
• 重现错误的详细步骤。

修复错误

浏览 GitHub 上的错误问题。任何标记为 "bug" 和 "help wanted" 的问题都欢迎任何人来实现。

实现功能

浏览 GitHub 上的功能问题。任何标记为 "enhancement" 和 "help wanted" 的问题都欢迎任何人来实现。

编写文档

Pytorch Tabular 总是需要更多的文档，无论是在官方的 Pytorch Tabular 文档中，还是在 docstrings 中，甚至在博客文章、文章等网络内容中。

提交反馈

发送反馈的最佳方式是在 https://github.com/manujosephv/pytorch_tabular/issues 提交问题。

如果您提议一个功能：

• 详细解释它将如何工作。
• 尽量缩小范围，以便更容易实现。
• 请记住这是一个志愿者驱动的项目，欢迎您的贡献 :)

开始行动！

准备好贡献了吗？以下是如何为本地开发设置 PyTorch Tabular。

git clone git@github.com:your_name_here/pytorch_tabular.git

• 在 GitHub 上 fork pytorch_tabular 仓库。

• 在本地克隆您的 fork 并切换到检出的文件夹：

  git clone git@github.com:your_name_here/pytorch_tabular.git
  cd pytorch_tabular
  

• 设置本地环境（最好在虚拟环境中）。

  使用 python 原生 venv：

  mkdir .env
  python3 -m venv .env/tabular_env
  source .env/tabular_env/bin/activate
  pip install -e .[dev]
  

• 创建一个用于本地开发的分支：

  git checkout -b name-of-your-bugfix-or-feature
  

  现在您可以在本地进行更改。

警告

永远不要在 master 分支上工作！

提示

提交信息要有意义。这将有助于审查和进一步处理 PR。

• 完成后，运行 pytest 单元测试，看看是否一切顺利。

  pytest tests/
  

注意

如果您添加了新功能，请为其添加测试。

• 完成更改并且所有测试用例都通过后，运行 pre-commit 以确保所有 linting 和格式化都正确完成。

  pre-commit run --all-files
  

  在审查后接受更改（如果有）。

警告

不要将 pre-commit 更改提交到 setup.cfg。该文件已从 bump2version 兼容性的一个钩子中排除。有关排除文件的完整和最新列表，请查看 .pre-commit-config.yaml 文件。

• 提交更改并将您的分支推送到 GitHub：

  git add .
  git commit -m "您对更改的详细描述。"
  git push origin name-of-your-bugfix-or-feature
  

• 通过 GitHub 网站提交拉取请求。

拉取请求指南

在提交拉取请求之前，请检查它是否符合以下指南：

1. 拉取请求应包含测试。
2. 如果拉取请求添加了功能，则应更新文档。将您的新功能放入带有 docstring 的函数中。

提示

要运行部分测试：

pytest tests\test_*

部署

提醒维护者如何部署。确保所有更改都已提交（包括 HISTORY.rst 中的条目）。然后运行：

bump2version patch # 可能的选项：major / minor / patch $ git push $
git push --tags

GitHub Actions 将处理其余部分。