贡献#

欢迎贡献，我们非常感谢！点滴积累，我们始终会给予认可。

贡献类型#

报告错误#

在 triton-inference-server/model_navigator#issues 报告错误。

如果您要报告错误，请包含

  • 您的操作系统名称和版本。

  • 有关您的本地设置的任何详细信息，可能有助于故障排除。

  • 重现该错误的详细步骤。

修复错误#

浏览 GitHub issues 查找错误。任何标记为 “bug” 和 “help wanted” 的问题都开放给任何想要实现它的人。

实现功能#

浏览 GitHub issues 查找功能。任何标记为 “enhancement” 和 “help wanted” 的问题都开放给任何想要实现它的人。

编写文档#

Triton Model Navigator 始终可以使用更多文档，无论是作为官方 Triton Model Navigator 文档的一部分，在文档字符串中，还是在网络上的博客文章、文章等中。

提交反馈#

发送反馈的最佳方式是在 triton-inference-server/model_navigator#issues 提交 issue。

如果您要提出功能建议

  • 详细解释它将如何工作。

  • 尽可能缩小范围，使其更易于实现。

签署您的工作#

我们要求所有贡献者对他们的提交进行 “签名”。这证明该贡献是您的原创作品，或者您有权在相同许可或兼容许可下提交它。

任何包含未签名的提交的贡献将不被接受。

要签署提交，您只需在使用 --signoff (或 -s) 选项提交更改时

$ git commit -s -m "Add cool feature.

这会将以下内容附加到您的提交消息中

Signed-off-by: Your Name <your@email.com>

通过这样做，您证明以下内容

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

开始行动！#

准备好贡献了吗？以下是如何设置 Triton Model Navigator 以进行本地开发。

  1. 在 GitHub 上 Fork Triton Model Navigator 仓库。

  2. 在本地克隆您的 Fork

$ git clone git@github.com:your_name_here/model-navigator.git

  1. 将您的本地副本安装到 virtualenv 中。假设您已安装 virtualenvwrapper，以下是如何设置您的 Fork 以进行本地开发

$ mkvirtualenv model_navigator
$ cd model_navigator/
$ make install-dev

  1. 为本地开发创建一个分支

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

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

  1. 完成更改后，检查您的更改是否通过了 linters 和测试，包括使用 tox 测试其他 Python 版本

$ make lint  # will run i.a. flake8 and pytype linters
$ make test  # will run a test with on your current virtualenv
$ make test-fw  # will run a framework test inside framework container

  1. 提交您的更改并将您的分支推送到 GitHub

$ git add .
$ git commit -s -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

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

拉取请求指南#

在您提交拉取请求之前，请检查它是否符合这些指南

  1. 拉取请求应包含测试。

  2. 如果拉取请求添加了功能，您应该更新文档。将您的新功能放入带有文档字符串的函数中，并将该功能添加到 README.md 中的列表中。

提示#

要运行测试的子集

$ pytest tests.test_model_navigator

发布#

作为对维护人员关于如何部署的提醒 - 确保您的所有更改都已提交（包括 CHANGELOG.md 中的条目）到 master 分支。然后运行

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

文档#

按照 Google 风格指南 中的定义添加/更新文档字符串。

贡献者许可协议 (CLA)#

Triton 要求所有贡献者（或其公司实体）将签署的 贡献者许可协议 副本发送至 triton-cla@nvidia.com。注意：没有公司附属关系的贡献者可以在 公司名称 和 公司地址 字段中填写 N/A。

在本页