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://hglab.ifacesoft.ru/framework/core/ice-data
git branch -M branch/default
git push -uf origin branch/default

与您的工具集成

[ ] [设置项目集成](https://hglab.ifacesoft.ru/framework/core/ice-data/-/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的顶部，说明开发已经放缓或完全停止。某人可能会选择分支您的项目或志愿成为维护者或所有者，使您的项目继续前进。您还可以明确请求维护者。

ifacesoft / ice-data

维护者

详细信息