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/onlineboxingmanager/enduron-core.git
git branch -M main
git push -uf origin main

集成您的工具

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