README

入门

为了使您更容易开始使用GitLab，以下是一些推荐的下一步操作。

已经是专家？只需编辑此README.md并将其变为自己的。想要简化？使用下面的模板！

添加您的文件

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

与您的工具集成

• [ ] [设置项目集成](https://gitlab.com/-/experiment/new_project_readme_content:bc1886e48f557849b33f74f7d283f8da?https://docs.gitlab.com/ee/user/project/integrations/)

与您的团队协作

• [ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:bc1886e48f557849b33f74f7d283f8da?https://docs.gitlab.com/ee/user/project/members/)
• [ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:bc1886e48f557849b33f74f7d283f8da?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
• [ ] [自动关闭来自合并请求的问题](https://gitlab.com/-/experiment/new_project_readme_content:bc1886e48f557849b33f74f7d283f8da?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
• [ ] [当管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:bc1886e48f557849b33f74f7d283f8da?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:bc1886e48f557849b33f74f7d283f8da?https://docs.gitlab.com/ee/ci/quick_start/index.html)
• [ ] [使用静态应用程序安全测试(SAST)分析代码中的已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:bc1886e48f557849b33f74f7d283f8da?https://docs.gitlab.com/ee/user/application_security/sast/)
• [ ] [使用自动部署将应用部署到Kubernetes、Amazon EC2或Amazon ECS](https://gitlab.com/-/experiment/new_project_readme_content:bc1886e48f557849b33f74f7d283f8da?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
• 使用基于拉的部署以改进Kubernetes管理（https://gitlab.com/-/experiment/new_project_readme_content:bc1886e48f557849b33f74f7d283f8da?https://docs.gitlab.com/ee/user/clusters/agent/）

编辑此README

当你准备好将此README作为自己的时，只需编辑此文件并使用下面的便捷模板（或者您可以自由地按自己的方式结构化它——这只是一个起点！）感谢makeareadme.com提供的此模板。

良好的README建议

每个项目都不同，因此请考虑哪些部分适用于您自己的项目。模板中使用的部分是大多数开源项目的建议。同时请注意，虽然README可能太长且详细，但太长总比太短好。如果您认为您的README太长，请考虑使用另一种形式的文档，而不是删除信息。

名称

为您的项目选择一个自解释的名称。

描述

让人们知道您的项目可以做什么。提供上下文，并添加任何可能不熟悉的参考链接。也可以在此处添加功能列表或背景子部分。如果您的项目有替代品，这也是列出不同因素的好地方。

徽章

在某些README中，您可能会看到传达元数据的小图像，例如项目是否所有测试都通过。您可以使用Shields在README中添加一些徽章。许多服务也有添加徽章的说明。

视觉

根据您正在制作的内容，包含截图甚至视频（您通常会看到GIF而不是实际视频）可能是个好主意。ttygif之类的工具可以帮助，但请查看Asciinema以获取更复杂的方法。

安装

在特定生态系统中，可能存在安装东西的常见方式，例如使用Yarn、NuGet或Homebrew。然而，请考虑阅读您的README的人可能是一位新手，希望得到更多指导。列出具体步骤有助于消除歧义，并让人们尽快开始使用您的项目。如果它只能在特定上下文中运行（例如特定编程语言版本或操作系统）或需要手动安装依赖项，也请添加一个要求子部分。

使用

自由使用示例，并在可能的情况下显示预期的输出。在README中包含您能展示的最小使用示例很有帮助，同时提供链接到更复杂的示例（如果它们太长而无法合理地包含在README中）。

支持

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

路线图

如果您对未来版本有想法，请将这些想法列在README中。

贡献

声明您是否接受贡献以及接受它们的要求。

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

您还可以记录用于检查代码或运行测试的命令。这些步骤有助于确保代码质量高，并降低意外破坏某物的可能性。如果需要外部设置，如启动Selenium服务器以在浏览器中测试，为运行测试提供说明尤其有帮助。

作者和致谢

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

许可协议

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

项目状态

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