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/acitd-php/test.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](https://gitlab.com/acitd-php/test/-/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中是个好主意。

贡献

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

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

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

作者和致谢

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

许可

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

项目状态

如果你已经没有能量或时间来维护你的项目，在README的顶部添加一条注释，说明开发已经放缓或完全停止。有人可能会选择分叉你的项目或志愿成为维护者或所有者，使你的项目继续进行。你还可以明确提出对维护者的请求。

acitd / test

维护者

详细信息