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.bkroot.de/mmbk/test.git
git branch -M 1.x
git push -uf origin 1.x

与您的工具集成

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

mmbk / test

维护者

详细信息