-
Notifications
You must be signed in to change notification settings - Fork 0
贡献规则
非常感谢您的贡献，各种贡献都值得鼓励和重视！💖
在做出贡献之前，请务必阅读相关部分，这将使项目的维护更加顺畅。📝
如果您有疑问，需要支持或讨论，请按照以下步骤操作：
- 在Discussions创建新的议题并正确归类。
- 在新建之前，请搜索是否已有重复的议题，如果重复，请在原议题中寻求答案或继续讨论。
- 如果是遇到问题，请尽可能详尽地描述您的使用环境以及出问题的上下文操作。
项目成员将尽快给与答复。
如果您在使用过程中遇到异常，请按照以下步骤操作：
- 在Discussions搜索是否有相关异常的议题与答案。
- 在Issue搜索是否有相关待办项正在进行中。
- 如果异常非常明显，在Issue新建用于建报告异常的issue并尽可能详尽地描述如何引发异常。
- 如果异常不容易复现，则在Discussions创建discussion并描述异常以及平台环境与上下文操作。
项目成员会尽快确认异常，如果成功定位异常，与此异常相关的修复将合并至主分支，同时此issue将被关闭。
如果您有意愿为工程提交异常修复，请遵循开发规范。
如果项目缺少您需要的功能，请按照以下步骤操作：
- 在Discussions搜索是否有相关功能的议题与答案。
- 在Issue搜索是否有相关待办项正在进行中。
- 如果没有结果，在Issue新建用于新增功能的issue并尽可能详尽地描述功能需求，并解释为什么现有功能和替代方法对您不起作用。
项目成员会尽快评估功能请求，并给issue添加对应label。
注意：项目成员不太可能接受每个提交的功能请求，如果拒绝请多理解。
被接受的issue会更新对应的label状态，如果确定开发者则会被标记开发中，长时间未确定开发者的issue会被标记请求帮助。
如果您有意愿为工程提交新增功能，请遵循开发规范。
贡献代码除了要遵循Pull Requests流程，还需遵循以下规范。
工程默认包括以下分支：
-
main 主分支
- 最新的发行版工程
- 禁止对该分支直接提交
- 必须在可以发行时由develop签出的release分支merge更新
-
develop 开发分支
- 最新的集成各开发任务的工程
- 禁止对该分支直接提交
- 新特性的开发从develop分支签出
- 新特性开发完成后对develop分支提交合并请求
-
release 发行分支
- 用于从develop签出到master的分支
- 禁止对该分支直接提交
- 随着发行流程创建与删除
- 期间只能合并错误修复，不可加入新增特性
新特性的开发与提交请针对develop分支，并且合并到develop分支。
工程使用vscode+rust-lang.rust插件开发并格式化代码，为保证代码风格连贯，使用其他工具提交前请使用rustfmt进行排版。具体的代码格式可以参考Rust Style Guide。
代码提交信息遵循Angular Commit Message Format。 使用vscode可以安装redjue.git-commit-plugin插件自动填写提交信息。
创建Pull Requests后，将由项目成员审核，通过后将merge到对应分支。如果存在问题，项目成员将在Pull Requests中描述问题原因并等待修改完成或关闭该Pull Requests。