pdga/异常

PDGA使用的自定义异常类。

1.4.0 2024-04-02 20:37 UTC

This package is auto-updated.

Last update: 2024-09-27 18:53:40 UTC


README

特性与错误修复分支

在创建新特性或错误修复时,通常首先确保你处于 develop 分支,并使用以下命令创建你的新分支:

git checkout -b <你的分支名>

如果你的任务有Jira工单,使用该工单编号和标题作为分支名是个不错的选择,但只要你的分支用途明确,你可以使用任何你想要的名称。

请注意,你不必总是从 develop 分支分叉,例如,如果你正在修改尚未合并到 develop 的内容,你将想要从那个其他现有分支分叉。记住你从哪个分支分叉是很重要的,以便你能够合并回那个分支。

一旦你的更改被提交并推送到远程,你就可以在GitHub上创建Pull Request。在你的网页浏览器中,导航到 https://github.com/PDGA/php-exceptions/pulls 并点击新建Pull Request。确保在 base 下拉菜单中选中的分支是你分叉的分支,以及在 compare 下拉菜单中选中的选项是你的分支。点击创建Pull Request,并在 添加描述 部分添加你的更改描述。确保至少选择两名审阅者,然后点击描述框下方的 创建Pull Request 以打开Pull Request。

合并Pull Request

一旦至少有两名人员批准了你的Pull Request,它可能被合并。有两种方法可以做到这一点:你可以使用GitHub上的GUI自动将你的分支合并到你选定的 base 分支,然后删除你的分支,或者你可以使用 git 命令行来完成同样的工作。

使用GitHub

在GitHub上,合并拉取请求 按钮位于主Pull Request页面底部。点击后,它将变为 删除分支 按钮。删除分支后,你应该将本地正在工作的分支更改为你在 base 下拉菜单中选择的分支,并运行以下命令:

git fetch -p
git pull

使用git命令行

要使用 git 命令,首先将当前工作分支更改到 base 分支。然后使用以下命令合并你的分支。

git merge <你的分支名>

一旦合并完成,所有冲突都已被解决并提交后,你必须将 base 分支推送到远程。

注意:不能直接从命令行将更改提交并推送到 develop,因此如果您的 base 分支是 develop,请参阅使用GitHub GUI进行合并的上述说明。

在此阶段,你可以从origin删除你的分支

git push -d origin <你的分支名>

在远程合并和删除后

从origin删除分支后,无论是手动还是通过GitHub,请确保在本地也删除它

git branch -d <你的分支名>

发布新版本

为了发布新的仓库版本,所有更改都需要通过拉取请求合并到develop分支。不能直接从命令行将更改提交并推送到develop分支,因此需要拉取请求。当您打算发布新版本时,您还希望更新CHANGELOG.md文件,列出在新版本号下进行的更改(有关版本号的信息请见下文)。一旦所有更改都已合并到develop分支,它需要再次通过拉取请求合并到main分支。一旦所有内容都合并到main分支,可以为仓库创建一个新标签并将其推送到远程仓库。

创建新标签

应使用以下命名方案为仓库创建新标签:

<主版本号.次版本号.修复版本号>

主版本号应在向仓库代码添加破坏性更改时递增。次版本号应在向仓库代码添加非破坏性、非修复更改时递增。修复版本号应在向仓库代码添加仅修复的更改时递增。

请注意,递增版本号会将该数字右侧的所有版本号都设置为0。例如,如果对版本1.4.29进行了破坏性更改,您将从一个1.4.29升级到2.0.0,而不是2.4.29

要创建新标签,请从命令行使用以下命令:

git tag -a <新标签版本号> -m "<关于此版本的注释>"

然后,

git push -u origin <新标签号>

在其他应用程序中使用包

该包可以通过Composer在PHP应用程序中使用。它可以通过Composer从Packagist中包含。

将包的新版本推送到Packagist

该包已在Packagist上设置,它监视仓库中的新标签,并自动创建新的发布版本以供Composer使用(Packagist页面可在https://packagist.org.cn/packages/pdga/exception找到)。因此,简单地推送新标签到仓库将触发新版本在Composer中可用。有时新版本需要一些时间才能可用。您可以在Packagist页面上验证新版本是否可用。

将包添加到其他应用程序

要将在应用程序的Composer依赖项中添加包,请使用以下Composer命令:

composer require pdga/exception

如果您正在使用该包,但主版本号已更改,您将使用上述命令更新包。

如果您想更新该包的现有依赖项,并且仅更改了次版本号或修复版本号,您可以在该应用程序中使用以下命令:

composer update pdga/exception

上述命令非常简单,但在指定要安装哪些版本方面有许多选项。有关更多信息,请参阅官方Composer文档

安装Composer依赖项

./bin/composer install

代码格式规范

运行PHP_CodeSniffer以查看现有的样式问题。

./bin/codesniffer

运行格式化器以自动修复可以修复的样式问题。

./bin/codeformatter