README

入门指南

为了帮助您轻松开始使用GitLab，以下是推荐的下一步操作列表。

已经是专家？只需编辑此README.md文件，使其成为您的专属。想要让它变得简单？使用底部的模板！

添加您的文件

• [ ] [创建](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) 或 上传 文件
• [ ] [使用命令行添加文件](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?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/karsegard/backpack-widgets.git
git branch -M main
git push -uf origin main

与您的工具集成

• [ ] [设置项目集成](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://gitlab.com/karsegard/backpack-widgets/-/settings/integrations)

与您的团队协作

• [ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/user/project/members/)
• [ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
• [ ] [合并请求自动关闭问题](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
• [ ] [启用合并请求批准](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
• [ ] [管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)

测试和部署

使用GitLab内建的持续集成。

• [ ] [开始使用GitLab CI/CD](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/ci/quick_start/index.html)
• [ ] [使用静态应用程序安全测试(SAST)分析代码中的已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/user/application_security/sast/)
• [ ] [使用自动部署部署到 Kubernetes、Amazon EC2 或 Amazon ECS](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
• [ ] [使用基于拉的部署来改进 Kubernetes 管理](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/user/clusters/agent/)
• [ ] [设置受保护的环境](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?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 中。

支持

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

路线图

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

贡献

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

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

您还可以记录用于代码检查或运行测试的命令。这些步骤有助于确保代码质量高，并减少意外破坏东西的可能性。如果有外部设置要求，例如在浏览器中进行测试时启动Selenium服务器，记录运行测试的说明特别有帮助。

作者和致谢

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

许可证

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

项目状态

如果您已经耗尽了您项目的精力和时间，请在README顶部注明开发已放缓或完全停止。有人可能会选择分支您的项目或志愿成为维护者或所有者，使您的项目继续进行。您还可以明确请求维护者。