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.rm.ingv.it/diego.sorrentino/collettore-unico-library.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](https://gitlab.rm.ingv.it/diego.sorrentino/collettore-unico-library/-/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中）。

支持

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

路线图

如果您对未来发行版有想法，在README中列出它们是个好主意。

贡献

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

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

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

作者和致谢

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

许可协议

对于开源项目，说明其许可协议。

项目状态

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

diego.sorrentino / collettore-unico-library

维护者

详细信息