README

开始使用

为了帮助您轻松开始使用GitLab，以下是一些推荐步骤。

已经是专家？只需编辑此README.md并将其变为您的专属版本。想让它变得简单？请使用底部的模板！

添加您的文件

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

集成您的工具

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

与您的团队协作

• [ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:401cd4c1ada8160754a61bcbedf09fde?https://docs.gitlab.com/ee/user/project/members/)
• [ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:401cd4c1ada8160754a61bcbedf09fde?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
• [ ] [自动关闭合并请求中的问题](https://gitlab.com/-/experiment/new_project_readme_content:401cd4c1ada8160754a61bcbedf09fde?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
• [ ] [管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:401cd4c1ada8160754a61bcbedf09fde?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:401cd4c1ada8160754a61bcbedf09fde?https://docs.gitlab.com/ee/ci/quick_start/index.html)
• [ ] [使用静态应用程序安全测试(SAST)分析已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:401cd4c1ada8160754a61bcbedf09fde?https://docs.gitlab.com/ee/user/application_security/sast/)
• [ ] [使用自动部署将应用程序部署到Kubernetes、Amazon EC2或Amazon ECS](https://gitlab.com/-/experiment/new_project_readme_content:401cd4c1ada8160754a61bcbedf09fde?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
• 使用基于拉取的部署来改进Kubernetes管理（https://gitlab.com/-/experiment/new_project_readme_content:401cd4c1ada8160754a61bcbedf09fde?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文件的顶部注明开发已经减缓或完全停止。有人可能会选择分支你的项目或自愿担任维护者或所有者，使你的项目继续进行。你还可以明确提出对维护者的请求。