README

PDGA后端PHP API系统的数据对象相关代码。

安装Composer依赖项

./bin/composer install

运行单元测试

./bin/phpunit

代码格式标准

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

composer sniff

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

composer format

或者

composer format-verbose

将此库作为依赖项添加到另一个应用程序中

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

composer require pdga/data-objects

如果该包已经在您的应用程序中使用，但主要版本号已更改，您将使用上述命令来更新包。

如果您想更新对该包的现有依赖，并且只有次要或错误修复版本已更改，您可以在该应用程序中使用以下命令

composer update pdga/data-objects

上述命令非常简单，但关于指定安装的版本有很多选项。有关更多信息，请参阅官方Composer文档。

功能特性和错误修复的分支

当创建新功能或错误修复时，您通常首先确保您在develop分支上，并使用以下命令创建新分支

git checkout -b <your-branch-name>

如果有Jira任务，则使用该任务编号和标题作为分支名称是一个不错的选择，但只要您的分支用途清晰，您可以使用任何您想要的名称。

请注意，您不总是必须从develop分支分支，例如，如果您要更改尚未合并到develop的某些内容，您将希望从那个其他现有分支分支。记住您从哪个分支分支非常重要，以便您合并回那个分支。

一旦您的更改已提交并推送到，您就可以在GitHub上创建Pull Request。在您的网页浏览器中，导航到https://github.com/PDGA/php-data-objects/pulls并点击New Pull Request。确保在base下拉菜单中选择的分支是您分支的分支，并且compare下拉菜单中选择的选项是您的分支。在Add a description部分中添加您的更改描述。确保选择至少两位审阅者，然后在描述框下方点击Create Pull Request以打开Pull Request。

合并Pull Request

一旦至少有两个人批准了您的Pull Request，它可能被合并。有两种方法可以做到这一点：您可以使用GitHub上的GUI自动将您的分支合并到您选择的base分支，然后删除您的分支，或者您可以使用git命令行来完成相同的事情。

使用GitHub

GitHub上的Merge pull request按钮位于主Pull Request页面的底部。单击它后，它将变为Delete Branch按钮。分支删除后，您应将本地工作的分支更改为您选择的base分支，并运行以下命令

git fetch -p
git pull

使用git命令行

要使用 git 命令，首先将当前工作分支切换到您的 base 分支。然后使用以下命令合并您的分支。

git merge <您的分支名称>

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

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

此时您可以删除您的分支。

git push -d origin <您的分支名称>

在远程合并和删除后

从远程删除分支后，无论是手动还是通过 GitHub，请确保在本地也删除它。

git branch -d <您的分支名称>

发布新版本

要发布存储库的新版本，所有更改都需要通过 Pull Request 合并到 develop。无法直接从命令行将更改提交并推送到 develop，因此需要 Pull Request。当您打算发布新版本时，您还希望更新 CHANGELOG.md 文件，其中包含在新版本号下进行的更改列表（有关版本号的信息见下文）。一旦所有更改都已合并到 develop，它需要再次通过 Pull Request 合并到 main。一旦一切合并到 main，可以为存储库创建一个新的标签并将其推送到远程。

创建新标签

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

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

主版本号应在向存储库代码添加重大更改时递增。次版本号应在向存储库代码添加非破坏性、非错误修复更改时递增。错误修复版本号应在仅向存储库代码添加错误修复时递增。

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

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

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

然后

git push -u origin <新标签号>

例如，版本 2.1.0 是通过以下命令进行标记和发布的

git tag -a 2.1.0 -m "Support passing Eloquent models to `ModelInstantiator#dataObjectToDatabaseModel` for efficiency."\
git push 2.1.0

将新版本的软件包推送到 Packagist

该软件包已在 Packagist 上设置，并监视存储库的新标签以自动创建新的发布版本，以便通过 Composer 使用（Packagist 页面可在 https://packagist.org.cn/packages/pdga/data-objects 找到）。因此，将新标签推送到存储库的简单操作将触发新版本在 Composer 中可用。有时新版本在可用之前可能需要一段时间。您可以在 Packagist 页面上验证新版本是否可用。