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/D3Zk0/starter.git
git branch -M main
git push -uf origin main

与您的工具集成

• [ ] [设置项目集成](https://gitlab.com/D3Zk0/starter/-/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的顶部注明开发已放缓或已完全停止。有人可能会选择分叉您的项目或自愿担任维护者或所有者，使项目得以继续。您还可以明确要求维护者。