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

与您的工具集成

[ ] [设置项目集成](https://gitlab.com/dinhduythien/nvc-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中，您可能会看到传达元数据的小图像，例如项目是否所有测试都通过。您可以使用盾牌为您的README添加一些徽章。许多服务也有添加徽章的说明。

视觉内容

根据您制作的内容，包含截图或视频（您通常会看到GIF而不是实际视频）是个好主意。例如，ttygif等工具可以帮助，但请查看Asciinema以获取更高级的方法。

安装

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

用法

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

支持

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

路线图

如果您对未来版本有想法，将其列在README中是个好主意。

贡献

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

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

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

作者和致谢

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

许可证

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

项目状态

如果您在项目上耗尽了精力或时间，请将一条注释放在README的顶部，说明开发已放缓或完全停止。有人可能选择分叉您的项目或志愿担任维护者或所有者，使您的项目能够继续进行。您还可以明确提出对维护者的请求。

员工公司 / nvc-store-core

维护者

详情