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/chipsa_dev/bitrix-iblock-access-checker.git
git branch -M main
git push -uf origin main

集成您的工具

[ ] [设置项目集成](https://gitlab.com/chipsa_dev/bitrix-iblock-access-checker/-/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顶部注明开发已经减慢或完全停止。有人可能会选择分支您的项目或自愿担任维护者或所有者，从而使项目继续进行。您还可以明确提出对维护者的请求。

chipsa / access_checker

维护者

详细信息