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/SylwesterKowal/magento-2-poprawki.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](https://gitlab.com/SylwesterKowal/magento-2-poprawki/-/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的顶部注明开发已经放缓或完全停止。有人可能会选择分叉您的项目或志愿成为维护者或所有者，使您的项目能够继续进行。您也可以明确请求维护者。

kowal / poprawki

维护者

详细信息