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-promocode.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](https://gitlab.com/SylwesterKowal/magento-2-promocode/-/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中，提供链接到更复杂的示例也很有用。

支持

告诉人们他们可以到哪里寻求帮助。可以是任何组合的issue tracker、聊天室、电子邮件地址等。

路线图

如果您对未来发布有想法，将其列出在README中是个好主意。

贡献

声明您是否接受贡献以及接受贡献的要求。

对于想要更改您项目的人来说，提供一些如何开始的文档很有帮助。可能有一些他们应该运行的脚本或需要设置的某些环境变量。明确这些步骤。这些说明也可能对您的未来自己有用。

您还可以记录检查代码或运行测试的命令。这些步骤有助于确保代码质量高，并减少更改无意中破坏某物的可能性。如果需要外部设置（如启动Selenium服务器以在浏览器中测试）运行测试，这些说明特别有用。

作者和致谢

感谢为项目做出贡献的人。

许可证

对于开源项目，说明其许可证。

项目状态

如果您对项目失去了精力和时间，在README顶部注明开发速度减慢或完全停止。有人可能会选择分支您的项目或志愿成为维护者或所有者，使您的项目继续进行。您还可以明确请求维护者。

cowal / module-promocode

维护者

详细信息