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://gitlab.glitchr.dev/public-repository/symfony/bundles/base-plugin.git
git branch -M main
git push -uf origin main

与您的工具集成

• [ ] [设置项目集成](http://gitlab.glitchr.dev/public-repository/symfony/bundles/base-plugin/-/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的顶部添加一条注释，说明开发已放缓或完全停止。有人可能选择分叉您的项目或自愿担任维护者或所有者，使项目继续进行。您还可以明确提出对维护者的请求。