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 http://192.168.11.252/root/pmp_bundle.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](http://192.168.11.252/root/pmp_bundle/-/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的顶部注明开发已经放缓或完全停止。有人可能会选择分叉您的项目或志愿成为维护者或所有者，使您的项目能够继续。您还可以明确要求维护者。

cred / pmp_bundle

维护者

详情