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.decimadigital.com/decimapub/base.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](https://gitlab.decimadigital.com/decimapub/base/-/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中是个好主意。

贡献

声明你是否欢迎贡献，以及接受贡献的要求。

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

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

作者和致谢

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

许可证

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

项目状态

如果你的项目耗尽了精力或时间，请在README的顶部添加一条说明，说明开发已经放缓或完全停止。有人可能会选择分支你的项目或自愿担任维护者或所有者，让你的项目继续进行。你也可以明确要求维护者。

decimapub / module-base

维护者

详细信息