README

入门

为了帮助您在GitLab中快速开始，以下是一些推荐的下一步操作。

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

添加您的文件

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

集成您的工具

• [ ] [设置项目集成](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://gitlab.com/druparcheky/recommended-project/-/settings/integrations)

与您的团队协作

• [ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/user/project/members/)
• [ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
• [ ] [自动从合并请求关闭问题](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
• [ ] [启用合并请求批准](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
• [ ] [管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?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:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/ci/quick_start/index.html)
• [ ] [使用静态应用安全测试(SAST)分析您的代码中的已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/user/application_security/sast/)
• [ ] [使用自动部署将应用部署到Kubernetes、Amazon EC2或Amazon ECS](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
• [ ] [使用基于拉取的部署以改进Kubernetes管理](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/user/clusters/agent/)
• [ ] [设置受保护的环境](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?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顶部注明开发已放缓或完全停止。有人可能会选择分支您的项目或自愿担任维护者或所有者，以便您的项目继续进行。您还可以明确请求维护者。