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/vitrin-solutions-public/event/vertex/auth.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](https://gitlab.com/vitrin-solutions-public/event/vertex/auth/-/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的顶部注明开发已经放缓或完全停止。有人可能选择分叉您的项目或志愿担任维护者或所有者，从而使项目继续进行。您还可以明确要求维护者。

vitrin-event / auth

维护者

详细信息