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/lock.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](https://gitlab.rm.ingv.it/diego.sorrentino/lock/-/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中，您可能会看到传达元数据的小图像，例如项目是否所有测试都通过。您可以使用Shields在README中添加一些徽章。许多服务也提供了添加徽章的说明。

视觉元素

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

安装

在特定生态系统中，可能存在安装事物的常见方式，例如使用Yarn、NuGet或Homebrew。但是，请考虑阅读您的README的人可能是一位新手，并希望得到更多指导。列出具体步骤有助于消除歧义，并尽快让人们使用您的项目。如果它只在特定的环境中运行，如特定的编程语言版本或操作系统，或者有需要手动安装的依赖项，也请添加要求子部分。

用法

广泛使用示例，并在可能的情况下展示预期的输出。如果您能展示最小的使用示例，同时提供链接到更复杂的示例（如果它们太长而无法合理地包含在README中），这会有所帮助。

支持

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

路线图

如果您对未来的发布有想法，将其列在README中是一个好主意。

贡献

说明您是否愿意接受贡献以及接受贡献的要求。

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

您还可以记录用于lint代码或运行测试的命令。这些步骤有助于确保高代码质量并降低更改无意中破坏东西的可能性。如果测试需要外部设置，例如在浏览器中进行测试时启动Selenium服务器，运行测试的说明特别有用。

作者和致谢

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

许可证

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

项目状态

如果您已经耗尽了为项目提供能量或时间的精力，请在README的顶部注明开发已放缓或已完全停止。有人可能会选择fork您的项目或志愿成为维护者或所有者，从而使您的项目继续进行。您还可以明确请求维护者。

diego.sorrentino / lock

维护者

详细信息