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

与您的工具集成

[ ] [设置项目集成](https://gitlab.rm.ingv.it/hsit/libs/-/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中，提供链接到更复杂的示例也很 helpful。

支持

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

路线图

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

贡献

声明您是否接受贡献以及接受贡献的要求。

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

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

作者和致谢

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

许可

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

项目状态

如果您已经没有精力或时间继续您的项目，在README顶部添加一条说明，说明开发已经放缓或完全停止。有人可能会选择fork您的项目或自愿担任维护者或所有者，使您的项目能够继续下去。您也可以明确要求维护者。

hsit / lib_dbmi

维护者

详情