Ctrl+K

贡献

贡献#

感谢您考虑为我们的Python包做出贡献！我们非常感谢您在帮助我们改进项目上所花费的时间和精力。请花一点时间查看以下指南，以确保贡献过程顺利高效。

行为准则#

我们恳请所有贡献者在参与此项目时遵守我们的行为准则。它概述了我们对社区内尊重和包容行为的期望。

设置开发环境#

要为此 Python 包设置开发环境，请按照以下步骤操作：

  1. 使用以下命令将仓库克隆到您的本地机器：

git clone https://github.com/basf/mamba-tabular

  1. 通过运行以下命令安装所需的依赖项：

pip install -r requirements.txt

如果需要更新文档，请安装文档所需的依赖项：

pip install -r docs/requirements_docs.txt

注意： 你也可以设置一个虚拟环境来隔离你的开发环境。

如何贡献#

  1. 从 develop 分支创建一个新的分支用于你的贡献。请使用描述性强且简洁的分支名称。

  2. 对代码库进行所需的更改或添加。

  3. 确保你的代码遵循 PEP8 编码风格指南。

  4. 为你的更改编写适当的测试，确保它们通过。

    • make test

  5. 如有必要，更新文档和示例。

  6. 构建html文档并验证其是否按预期工作。我们使用了Sphinx进行文档编写，您可以按如下方式构建文档：

    • cd src/docs

    • make clean

    • make html

  7. 验证在 docs/_build/html 目录下创建的 html 文档。index.html 文件是主文件，包含指向所有其他文件和 doctree 的链接。

  8. 使用清晰简洁的提交信息提交您的更改。

  9. 从你的分支向原始仓库的开发分支提交一个拉取请求。

  10. 等待维护者审查你的拉取请求。如果需要，处理任何反馈或评论。

  11. 一旦获得批准，您的更改将被合并到主代码库中。

提交贡献#

在提交您的贡献时，请确保以下事项：

  • 在你的拉取请求中包含一个清晰简洁的变更描述。

  • 在拉取请求描述中引用任何相关的问题或功能请求。

  • 确保你的代码遵循项目的编码风格和约定。

  • 包含适当的测试以覆盖你的更改，确保它们成功通过。

  • 如有必要，更新文档以反映所做的更改。

  • 确保你的拉取请求具有单一的、逻辑上的焦点。

问题追踪器#

如果你遇到任何错误，有功能请求，或需要帮助，请访问我们的 问题追踪器。在创建新问题之前，请确保搜索现有问题。

许可证#

通过为本项目做出贡献，您同意您的贡献将根据项目的LICENSE进行许可。请注意，上述指南可能会发生变化，项目维护者有权拒绝或要求对任何贡献进行修改。感谢您的理解和支持，帮助我们使这个项目变得更好！

目录