为了让您轻松上手 GitLab，这里列出了推荐的后续步骤。
已经是专家了？只需编辑此 README.md 文件，让它成为您自己的。想要更简单？使用底部的模板！
cd existing_repo
git remote add origin https://gitlab.com/zzugab/juice-shop-with-kubeadm-and-tf.git
git branch -M main
git push -uf origin main
使用 GitLab 内置的持续集成功能。
当您准备好将此 README 变成自己的时，只需编辑此文件并使用下面的便捷模板（或者随意按您喜欢的方式构建——这只是一个起点！）。感谢 makeareadme.com 提供此模板。
每个项目都不同，所以请考虑哪些部分适用于您的项目。模板中使用的部分是对大多数开源项目的建议。同时请记住，虽然 README 可以太长太详细，但过长总比过短好。如果您觉得 README 过长，可以考虑使用其他形式的文档，而不是删减信息。
为您的项目选择一个自解释的名称。
让人们知道您的项目能做什么。提供上下文，并添加指向访问者可能不熟悉的任何参考资料的链接。可以在此处添加功能列表或背景子章节。如果您的项目有替代方案，这里是说明差异化因素的好地方。
在某些 README 上，您可能会看到传达元数据的小图片，例如项目是否通过了所有测试。您可以使用 Shields 添加一些徽章到您的 README 中。许多服务也提供了添加徽章的说明。
根据您制作的内容，包含截图甚至视频是个好主意（您经常会看到 GIF 而不是实际视频）。像 ttygif 这样的工具有帮助，但可以查看 Asciinema 以获得更高级的方法。
在特定的生态系统中，可能有常见的安装方式，例如使用 Yarn、NuGet 或 Homebrew。但是，请考虑到阅读您 README 的人可能是新手，需要更多指导。列出具体步骤有助于消除歧义，让人们尽快使用您的项目。如果它只在特定的上下文中运行，例如特定的编程语言版本或操作系统，或者有需要手动安装的依赖项，也请添加“要求”子章节。
多使用示例，并尽可能显示预期的输出。最好在行内展示您能演示的最小使用示例，同时提供指向更复杂示例的链接（如果它们过长而无法合理包含在 README 中）。
告诉人们可以去哪里寻求帮助。可以是问题追踪器、聊天室、电子邮件地址等的任意组合。
如果您对未来版本有想法，最好在 README 中列出它们。
说明您是否接受贡献以及接受贡献的要求。
对于想要对您的项目进行更改的人，提供一些如何开始使用的文档会很有帮助。可能有一个他们应该运行的脚本，或者一些需要设置的环境变量。明确说明这些步骤。这些说明对未来的您也可能有用。
您还可以记录用于 lint 代码或运行测试的命令。这些步骤有助于确保高代码质量，并降低更改意外破坏某些东西的可能性。如果测试需要外部设置（例如在浏览器中测试时需要启动 Selenium 服务器），提供运行测试的说明尤其有用。
对为项目做出贡献的人表示赞赏。
对于开源项目，说明其许可证。
如果您对项目失去了精力或时间，请在 README 顶部注明开发已放缓或已完全停止。可能会有人选择 fork 您的项目或自愿成为维护者或所有者，从而使项目继续发展。您也可以明确请求维护者。