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.die-netzmacher.de/typo3/migration_bootstrapgrids2start.git
git branch -M main
git push -uf origin main

集成您的工具

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

verdigado / migration-bootstrapgrids2start

维护者

详细信息