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://git.dev.epartment.nl/conneqt/m2/sap-special-prices.git
git branch -M develop
git push -uf origin develop

集成您的工具

[ ] [设置项目集成](https://git.dev.epartment.nl/conneqt/m2/sap-special-prices/-/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中，提供链接到更复杂的示例也很 helpful。

支持

告诉人们他们可以到哪里寻求帮助。这可以是任何组合，包括问题跟踪器、聊天室、电子邮件地址等。

路线图

如果您对未来发布有想法，请将它们列入README。

贡献

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

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

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

作者和致谢

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

许可

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

项目状态

如果您在项目上耗尽了精力或时间，请在README的顶部添加一条说明，说明开发已经放缓或已完全停止。有人可能会选择分叉您的项目或自愿担任维护者或所有者，使项目继续进行。您还可以明确请求维护者。

conneqt / module-sap-service-layer-special-prices

维护者

详细信息