贡献代码

提交PR

SwiftAdmin极速开发框架,致力于为中小企业(创业者)提供一款高颜值,可操作性与效率并存的PHP开发框架,依赖于ThinkPHP Layui活跃生态环境。

让您在开发、扩展上得心应手,实现高效益!!!欢迎您为swiftadmin极速后台开发框架贡献您的代码,可以是修复BUG,修复HTML元素或者标签;

轻量级提交

Gitee 轻量级 PR (Gitee Pull Request Lite)是一种 无须 Fork 仓库,即可快速向某个特定仓库创建并提交一个合并请求( Pull Request )的功能。

在开源世界中,大多数开发者并不是开源项目仓库的开发者( Developer )或维护者( Maintainer ),因此大多数开发者向一个开源项目提交贡献往往需要以下几个步骤完成:

  1. 开发者 Fork 主仓库到自己账号成为副本仓库
  2. 在副本仓库完成代码贡献(添加、删除、修改代码等等)
  3. 将副本修改的内容给主仓库提交 PR (Pull Request)
  4. 作者审核你提交的代码,并决定是否合并

上述过程用户需要将开源项目仓库 Fork 一份副本,占用名下仓库空间,在 Fork 和 Clone 过程中存在一定的网络传输和等待时间,为创建一个 Pull Request 带来一定的时间和操作成本。

通过 轻量级 PR ,开发者只需在 Web 端完成代码贡献(添加、删除、修改代码等等),就能一键向开源项目仓库提出 Pull Request 请求,减去了中间大量的繁琐操作。

单文件修改,秒速创建轻量级 PR

以向开源项目 https://gitee.com/normalcoder/Gitee-Trending-Explore-for-Alfred-Workflow 提交 PR 完善 README 内容为例,

在浏览其开源项目 README 时,发现其中可以改进的地方,通过访问相应仓库文件内容,在页面上找到 「编辑」 按钮,无需 Fork 仓库到自己的Gitee 帐号名下,即可直接进入编辑页面。在完善内容并填写提交信息后,通过点击 「提交审核」 ,即可创建向作者快速创建并提交一个轻量级 PR,待作者审核通过后即可合入仓库。

多文件编辑,无须 Fork-Clone-commit-Push,在线创建轻量级PR

以向开源项目 Gitee-Trending-Explore-for-Alfred-Workflow 提交 PR 完善 README 内容为例,

在浏览其开源项目 README 时,发现其中可以改进的地方,通过访问相应仓库文件内容,在页面上找到 「WebIDE」 按钮,无需 Fork 仓库,进入 WebIDE 编辑界面。在 WebIDE 中编辑完善后,在提交改动内容并创建轻量级 PR,即可创建向作者快速创建并提交一个轻量级 PR,待作者审核通过后即可合入仓库。

FORK仓库

参与 Gitee 中的仓库开发,最常用和推荐的首选方式是“Fork + Pull”模式。在“Fork + Pull”模式下,仓库参与者不必向仓库创建者申请提交权限,而是在自己的托管空间下建立仓库的派生(Fork)。至于在派生仓库中创建的提交,可以非常方便地利用 Gitee 的 Pull Request 工具向原始仓库的维护者发送 Pull Request。

1、什么是 Pull Request?

Pull Request 是两个仓库提交变更的一种方式,通常用于 fork 仓库与被 fork 仓库的差异提交,同时也是一种非常好的团队协作方式,下面,就来讲解如何在 Gitee 平台提交 Pull Request: PS:Gitee 平台限制 Pull Request 源仓库与目标仓库需存在 fork 与被 fork 关系,故如果你要提交 Pull Request,必须先 fork 一个仓库,然后才能对该仓库提交 Pull Request,同时,以该仓库为父仓库的所有仓库,您也均可以提交 Pull Request。

2、如何 fork 仓库

fork 仓库时非常简单的,进到仓库页面,然后找到右上角的 fork 按钮,点击后选择 fork 到的命名空间,再点击确认,等待系统在后台完成仓库克隆操作,就完成了 fork 操作,如图:

3、如何提交 Pull Request

首先,您的仓库与目标仓库必须存在差异,这样才能提交,比如这样: 如果不存在差异,或者目标分支比你提Pull Request的分支还要新,则会得到这样的提示: 然后,填入Pull Request的说明,点击提交Pull Request,就可以提交一个Pull Request了,就想下图所示的那样:

4、如何对已经存在的 Pull Request 的进行管理

首先,对于一个已经存在的 Pull Request,如果只是观察者,报告者等权限,那么访问将会受到限制,具体权限限制请参考 Gitee 平台关于角色权限的内容,下文涉及的部分,仅针对管理员权限,如果您发现不太一样的地方,请检查您的权限是不是管理员或该 Pull Request 的创建者。

5、如何修改一个已经存在的 Pull Request

点击 Pull Request 的详情界面右上角的编辑按钮,就会弹出编辑框,在编辑框中修改你需要修改的信息,然后点击保存即可修改该 Pull Request,如下图所示: 请注意,在该界面,可以对 Pull Request 进行指派负责人,指派测试者等等操作,每一个操作均会通知对应的人员

6、对 Pull Request 的 bug 修改如何提交到该 Pull Request 中

对于 Pull Request 中的 bug 修复或者任何更新动作,均不必要提交新的 Pull Request,仅仅只需要推送到您提交 Pull Request 的分支上,稍后我们后台会自动更新这些提交,将其加入到这个 Pull Request 中去

7、Pull Request 不能自动合并该如何处理

在提交完 Pull Request 的后,在这个 Pull Request 处理期间,由原本的能自动合并变成不能自动合并,这是一件非常正常的事情,那么,这时,我们有两种选择,一种,继续合并到目标,然后手动处理冲突部分,另一种则是先处理冲突,使得该 Pull Request 处于可以自动合并状态,然后采用自动合并,一般来讲,我们官方推荐第二种,即先处理冲突,然后再合并。具体操作为: 先在本地切换到提交 Pull Request 的分支,然后拉取目标分支到本地,这时,会发生冲突,参考如何处理代码冲突 这一小节将冲突处理完毕,然后提交到 Pull Request 所在的分支,等待系统后台完成Pull Request的更新后,Pull Request 就变成了可自动合并状态

8、Pull Request 不小心合并了,可否回退

对于错误合并的 Pull Request,我们提供了回退功能,该功能会产生一个回退 XXX 的 Pull Request,接受该 Pull Request 即可完成回退动作,注意,回退本质上是提交一个完全相反的 Pull Request,所以,你仍然需要进行测试来保证完整性,另,为了不破坏其他 Pull Request,建议只有需回退的 Pull Request 处于最后一次合并操作且往上再无提交时执行回退动作,否则请手动处理。

反馈BUG

当你在使用过程中遇到问题,请查阅 常见问题 或者在 SAPHP问答社区 提交你的问题。

最后更新时间:2022-07-13 00:41:202454
https://doc.swiftadmin.net/help/17.html