README

PHP Webmaster 框架

入门

为了帮助您快速入门 GitLab，以下是一些推荐步骤。

已经是专家了吗？只需编辑这个 README.md 并使其成为您的专属。想要更简单？使用底部的模板！

添加您的文件

[ ] [创建](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) 或上传文件
[ ] [使用命令行添加文件](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) 或使用以下命令推送现有的 Git 仓库

cd existing_repo
git remote add origin https://gitlab.com/PHPUtil/phputil.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://gitlab.com/PHPUtil/phputil/-/settings/integrations)

与您的团队协作

[ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/user/project/members/)
[ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
[ ] [自动关闭合并请求中的问题](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
[ ] [启用合并请求批准](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
[ ] [在管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)

测试和部署

使用 GitLab 内置的持续集成。

[ ] [开始使用 GitLab CI/CD](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/ci/quick_start/index.html)
[ ] [使用静态应用安全测试(SAST)分析代码中的已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/user/application_security/sast/)
[ ] [使用自动部署将应用部署到 Kubernetes、Amazon EC2 或 Amazon ECS](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
[ ] [使用基于拉的部署以改进Kubernetes管理](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/user/clusters/agent/)
[ ] [设置受保护的环境](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/ci/environments/protected_environments.html)

编辑此README

当您准备好使此README成为您自己的时，只需编辑此文件并使用下面的便捷模板（或者您可以自由地按照自己的方式组织它——这只是一个起点！）感谢makeareadme.com 提供此模板。

良好的README建议

每个项目都是不同的，因此请考虑哪些部分适用于您自己的项目。模板中使用的部分是大多数开源项目的建议。同时请注意，虽然README可能太长太详细，但太长总比太短好。如果您认为您的README太长，可以考虑使用其他形式的文档，而不是删除信息。

名称

为您的项目选择一个具有自解释性的名称。

描述

让人们了解您的项目具体能做什么。提供上下文并添加链接，以便访问者了解任何不熟悉的内容。这里也可以添加功能列表或背景子部分。如果您的项目有替代方案，这是列出不同因素的好地方。

徽章

在某些README中，您可能会看到传达元数据的小图像，例如项目是否所有测试都通过。您可以使用盾牌添加一些到您的README。许多服务也有添加徽章的说明。

视觉内容

根据您正在制作的内容，包含截图甚至视频（您通常会发现GIF而不是实际的视频）。像ttygif这样的工具可以帮助，但请查看Asciinema以获得更复杂的方法。

安装

在特定的生态系统中，可能存在安装事物的常见方式，例如使用Yarn、NuGet或Homebrew。然而，请考虑阅读您的README的人可能是一位新手，并希望得到更多的指导。列出具体步骤有助于消除歧义，并尽快让人们开始使用您的项目。如果它仅在特定的上下文中运行（如特定的编程语言版本、操作系统或需要手动安装的依赖项），也请添加要求子部分。

使用方法

广泛使用示例，并在可能的情况下展示预期的输出。如果您能展示最小的使用示例，同时提供链接到更复杂的示例（如果它们太长而无法合理地包含在README中），则非常有帮助。

支持

告诉人们他们可以到哪里寻求帮助。可以是任何组合的问题跟踪器、聊天室、电子邮件地址等。

路线图

如果您对未来发布有任何想法，将它们列入README中是个好主意。

贡献

说明您是否接受贡献以及接受贡献的要求。

对于想要对您的项目进行更改的人，有一些建议如何开始的文档会有所帮助。也许有一些脚本他们应该运行，或者一些需要设置的环境变量。明确这些步骤。这些说明也可能对您的未来自己有用。

您还可以记录用于代码检查或运行测试的命令。这些步骤有助于确保代码质量高，并减少更改意外破坏某物的可能性。如果有外部设置要求（如启动Selenium服务器进行浏览器测试），提供运行测试的说明尤其有帮助。

作者和致谢

感谢为项目做出贡献的人。

许可证

对于开源项目，说明其许可证。

项目状态

如果您在项目上耗尽了精力或时间，请在README顶部注明开发已放缓或完全停止。有人可能会选择分支您的项目或自愿担任维护者或所有者，使您的项目继续进行。您还可以明确请求维护者。

utilset

维护者

详细信息