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

与您的工具集成

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

mkulas / commands

维护者

详细信息