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/voodoo-rocks/yii2-env.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](https://gitlab.com/voodoo-rocks/yii2-env/-/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中，您可能会看到传达元数据的小图像，例如项目是否所有测试都通过。您可以使用盾牌在README中添加一些。许多服务也提供了添加徽章的说明。

视觉

根据您正在制作的内容，包含截图甚至视频（您通常会看到GIF而不是实际视频）。ttygif等工具可以帮助，但请查看Asciinema以获取更高级的方法。

安装

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

用法

自由使用示例，并展示预期的输出。如果您可以，将使用示例的最小示例内联展示，同时提供链接到更复杂的示例，如果它们太长，无法合理地包含在README中。

支持

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

路线图

如果您对未来发布有想法，将其列在README中是一个好主意。

贡献

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

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

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

作者和致谢

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

许可证

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

项目状态

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

魔法石头 / yii2-env

维护者

详细信息