README

入门指南

为了帮助您轻松开始使用GitLab，以下是推荐的下一步操作列表。

已经是老手？只需编辑此README.md并使其成为您的专属。想让它变得简单？使用下面的模板！

添加您的文件

• [ ] [创建](https://gitlab.com/-/experiment/new_project_readme_content:ddcfc8119049e459c3f5e178d4a35b0c?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) 或 上传 文件
• [ ] [使用命令行添加文件](https://gitlab.com/-/experiment/new_project_readme_content:ddcfc8119049e459c3f5e178d4a35b0c?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/Saeedeben/kavenegar.git
git branch -M main
git push -uf origin main

与您的工具集成

• [ ] [设置项目集成](https://gitlab.com/-/experiment/new_project_readme_content:ddcfc8119049e459c3f5e178d4a35b0c?https://docs.gitlab.com/ee/user/project/integrations/)

与您的团队协作

• [ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:ddcfc8119049e459c3f5e178d4a35b0c?https://docs.gitlab.com/ee/user/project/members/)
• [ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:ddcfc8119049e459c3f5e178d4a35b0c?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
• [ ] [自动关闭来自合并请求的问题](https://gitlab.com/-/experiment/new_project_readme_content:ddcfc8119049e459c3f5e178d4a35b0c?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
• [ ] [管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:ddcfc8119049e459c3f5e178d4a35b0c?https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)

测试和部署

使用GitLab内置的持续集成。

• [ ] [开始使用GitLab CI/CD](https://gitlab.com/-/experiment/new_project_readme_content:ddcfc8119049e459c3f5e178d4a35b0c?https://docs.gitlab.com/ee/ci/quick_start/index.html)
• [ ] [使用静态应用安全测试(SAST)分析您的代码以查找已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:ddcfc8119049e459c3f5e178d4a35b0c?https://docs.gitlab.com/ee/user/application_security/sast/)
• [ ] [使用自动部署部署到 Kubernetes、Amazon EC2 或 Amazon ECS](https://gitlab.com/-/experiment/new_project_readme_content:ddcfc8119049e459c3f5e178d4a35b0c?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
• [ ] [使用基于拉的部署以改进 Kubernetes 管理](https://gitlab.com/-/experiment/new_project_readme_content:ddcfc8119049e459c3f5e178d4a35b0c?https://docs.gitlab.com/ee/user/clusters/agent/)

编辑此 README

当你准备好将此 README 作为自己的文档时，只需编辑此文件并使用下面的便捷模板（或者你可以自由地构建它——这只是一个起点！）感谢 makeareadme.com 提供的此模板。

良好 README 的建议

每个项目都是不同的，所以请考虑哪些部分适用于您的项目。模板中使用的部分是大多数开源项目的建议。同时请注意，虽然 README 可以很长且很详细，但太长总比太短好。如果您认为您的 README 太长，请考虑使用另一种形式的文档，而不是删除信息。

名称

为您的项目选择一个自我解释的名称。

描述

让人们知道您的项目具体能做什么。提供上下文并添加任何可能不熟悉的参考链接。也可以在此处添加功能列表或背景子部分。如果您的项目有替代品，这是一个列出不同因素的好地方。

徽章

在某些 README 中，您可能会看到传达元数据的小图像，例如项目是否所有测试都通过。您可以使用 Shields 在您的 README 中添加一些。许多服务也有添加徽章的说明。

视觉元素

根据您正在制作的内容，包含截图甚至视频（您通常会看到 GIF 而不是实际视频）。ttygif 等工具可以帮助，但请检查 Asciinema 以获得更复杂的方法。

安装

在特定的生态系统内，可能存在一种常见的安装方式，例如使用 Yarn、NuGet 或 Homebrew。然而，考虑到阅读您的 README 的人可能是一位新手，并希望获得更多指导。列出具体步骤有助于消除歧义并尽快让人们开始使用您的项目。如果它仅在特定上下文中运行（如特定的编程语言版本或操作系统）或需要手动安装的依赖项，请添加一个“要求”子部分。

用法

广泛使用示例，并在可能的情况下显示预期输出。将尽可能小的使用示例内联，同时提供指向更复杂示例的链接（如果它们太长而无法合理包含在 README 中）。

支持

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

路线图

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

贡献

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

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

您还可以记录用于代码检查或运行测试的命令。这些步骤有助于确保代码质量高，并减少意外破坏东西的可能性。如果需要外部设置，例如在浏览器中测试时启动Selenium服务器，那么运行测试的说明尤其有帮助。

作者和致谢

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

许可证

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

项目状态

如果您已经耗尽了为项目投入的能量或时间，请在README的顶部注明开发已放缓或已完全停止。有人可能会选择分叉您的项目或志愿担任维护者或所有者，使您的项目得以继续。您还可以明确提出对维护者的请求。