首先,非常感谢您考虑向 Runtime 提交开源贡献。
在此之前,请阅读下面的开源贡献指南,并遵守 issue 和PR提交规则。为了大家能在 github 上无障碍沟通,我们强烈建议您使用英文提交 issue 或PR。
Runtime 使用 github 的 issue 系统来管理bug
和功能提议
。在您创建一个新的 issue 之前,请首先通过 issue 搜索查看是否已经存在相同或类似的 issue ,如果您的情况跟已存在的 issue 类似,您只需要在已存在的 issue 中通过回复追加您的情况即可。如果您确认不存在类似 issue ,那么别犹豫,请创建一个新的 issue 。
在创建 issue 时,请使用我们已经提供的 issue 模板,并在模板中填写下述内容:
- 简要的描述 issue 的主要问题。
- 您的系统环境。 包括 Runtime 的版本,OS/Python 版本等信息。
- 请描述您认为应该发生的情况。
- 请描述您实际观察到的情况。
- 请提供日志、截图等可能有用的线索,如果可能,请提供一份最小可验证的代码样例帮助我们确认问题。
注意: issue 系统只面向提交bug和功能建议使用。如果您是想咨询技术细节或其他问题,请首先查看我们的wiki。任何不符合上述要求的 issue ,可能会在无任何通知的情况下被关闭。
Runtime 通过 github 标准PR(Pull Request)流程接受代码贡献。请首先 fork 代码库,将修复代码提交到 fork 的代码库,并提交一个PR到Runtime 。代码维护人员会在收到PR后,对您提交的代码进行 Code Review,并在确认没问题后合入主干代码。
请使用下述模板提交 pull request:
- PR中代码修改的目的是什么?
- 简要描述您解决此问题的方案。
所有的PR需要对应到 issue ,并在PR描述中附带对应的 issue 编号。您提交的PR需要通过至少两位代码维护人员的 Review,这可能需要一定时间,请您耐心等待。
注意: 您的代码需要满足一般的 Python 语言编程规范。