README

入门指南

为了让您更容易开始使用GitLab，以下是一些建议的下一步行动。

已经是专家了吗？只需编辑此README.md，并使其成为您的专属。想要简化操作？使用底部的模板！

添加您的文件

[ ] [创建](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file)或上传文件
[ ] [使用命令行添加文件](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/fdt2k/php-helpers.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](https://gitlab.com/fdt2k/php-helpers/-/settings/integrations)

与您的团队协作

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

测试和部署

使用GitLab内建的持续集成。

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

编辑此README

当您准备好使此README成为您自己的时，只需编辑此文件并使用下面的方便模板（或者您可以随意构建它 - 这只是一个起点！）。感谢makeareadme.com提供此模板。

关于好的README的建议

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

名称

为您的项目选择一个易于解释的名称。

描述

让人们知道您的项目具体能做什么。提供上下文，并添加任何可能不熟悉的参考链接。也可以在这里添加功能列表或背景子部分。如果您的项目有替代品，这也是列出不同之处的好地方。

徽章

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

视觉

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

安装

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

用法

自由使用示例，并在可能的情况下显示预期输出。在README中包含最小示例用法是有帮助的，同时提供链接到更复杂的示例，如果它们太长而无法合理包含在README中。

支持

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

路线图

如果您对未来发布的想法，将它们列在README中是个好主意。

贡献

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

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

您还可以记录检查代码或运行测试的命令。这些步骤有助于确保代码质量高，并减少无意中破坏东西的可能性。如果需要外部设置（例如启动Selenium服务器以在浏览器中进行测试），运行测试的说明特别有用。

作者和致谢

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

许可证

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

项目状态

如果您已经耗尽了为项目投入的能量或时间，请在README的顶部添加一条说明，说明开发已经放缓或完全停止。有人可能会选择分叉您的项目或自愿担任维护者或所有者，使您的项目能够继续。您还可以明确要求维护者。

fdt2k / php-helpers

维护者

详细信息