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/hmt-packages/vnau.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](https://gitlab.com/hmt-packages/vnau/-/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的顶部注明开发已经放缓或完全停止。有人可能会选择分支您的项目或志愿担任维护者或所有者，以使项目继续进行。您还可以明确提出对维护者的请求。

hmt / laravel-vnau

维护者

详细信息