inBuilder 低代码平台开发者分享课丨提交 PR 的正确姿势

目前开源技术已经得到广泛应用，特别是在云计算、人工智能、区块链等领域。使用开源软件、参与开源软件的开发已成为开发者提升自己开发能力，打造个人名片的有效渠道之一。浪潮最近也是发布了免费的企业级低代码平台 —— 浪潮海岳 inBuilder 开源社区版，它是基于统一业务建模语言 UBML 开源项目的一个可以广泛使用的发行版。欢迎对低代码领域感兴趣或者在低代码领域有耕耘过的有志之士加入 UBML 开源社区的大家庭中来贡献自己的力量，与社区共成长。

参与社区贡献的第一步，我们需要知悉如何正确的提交 PR。

什么是 PR？

PR 是 Pull Request 的缩写。在开源社区中，Pull Request 是一种提交代码的方式。开源社区中的开发者可以在代码库中创建分支，并对代码进行修改和更新，然后提交 Pull Request 请求，请求贡献者帮助审核和合并这个分支。审核者会审查代码是否符合代码库的代码规范，并确认修改后的代码不会对原有代码产生影响，然后批准合并代码，或者提出改进意见，待贡献者对修改意见进行修改后再次提交 PR 请求。通过这种方式，代码库可以不断得到完善和更新，也可以促进开源社区的交流与合作。

怎样提交 PR?

以开源 UBML 项目中 farris-vue 为例，在注册 gitee 账号并登录后，按照以下步骤即可。

第一步是 fork 开源的项目，将其克隆到自己的本地代码库:

在自己的仓库中，就可以看到 fork 下来的代码。

第二步，本地进行修改，提交 commit：

将代码 clone 到本地，使用编辑器进行代码的修改和编写完成开发工作，将修改的工作先提交到自己的仓库中。

第三步，提交 Pull Request：

在 Gitee 上找到刚才修改的地方，点击 Pull Request 按钮，填写请求信息，并等待审核即可。

如何正确提交 PR

PR 提交格式可以根据具体的项目要求和开发团队的协作流程来定义，不同的项目可能会有略微不同的规范。下面是 UBML 社区中常用的 PR 提交格式规范。

1)   描述

该部分主要是详细描述本次提交完成的任务，包括更新了哪些功能、修复了哪些问题；同时，也可以阐述一下本次提交的背景、意义和目的等相关信息。

2)   关联 Issues

开源社区中的 Issues 通常是指项目开发和维护过程中所遇到的问题或者 bug。在开源项目中，用户可以提出 Issue 来报告发现的问题，然后由开发者对这些问题进行修复或者反馈，以提高项目的质量和稳定性。除了 bug 之外，issue 还可以用于功能请求、建议和讨论等用途，正确的关联 Issue 可以方便社区中其他人员参与相关的问题的讨论和交流。

3)   测试用例

描述可以测试自己工作内容相关的案例，相关人可以根据案例相关描述来复现体提交的 PR 中相关问题修复或者新增功能检验的场景。

4)   展示效果

该部分通常用截图的形式，展示的内容通常是 bug 修复后程序运行的效果或者新增功能特性的运行效果，效果展示尽量简洁直观，能够快速让相关人员在极短的时间内确定测试用例运行后呈现出来的理想结果。

下面以 farris-vue 中实现 Tags 组件的 Issue 为例,在我们领取这个 Issue 并且完成该新功能后，提交 PR 时就可参考以下的简单案例来写：

标题：实现 Tags 组件

描述：

在本次更改中增加了一些代码，以实现 Tags 组件的相关功能。

用户可以通过引用该组件，且可以通过一些属性的配置，实现不同风格 Tags 的展示工作。

测试用例：要视具体情况而定，这里省略，具体可以去 UMBL 中参考。

展示效果：

结语

最后，高效且正确地提交 PR 不仅可以显著地提高开发效率，满足了团队高的需求也让自己学习到了更多的知识。同时掌握了这技能，也让开发者以更高的姿态跨越技能线，进而迈向更专业的技能大师之路。另外无需担心自己的开发经验和水平达不到，在社区中你都可以找到自己的兴趣点和正确定位，赶紧加入 UBML 社区并开始正确的提交自己的第一次 PR，与社区共同成长，正式开启自己开源之旅吧！

参与源代码贡献，请到UBML开源社区

下载使用 inBuilder 开源社区版，请到inBuilder低代码社区