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.com/nextstage1/public-projects/ns-google-utils.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](https://gitlab.com/nextstage1/public-projects/ns-google-utils/-/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的顶部注明开发已放缓或已完全停止。有人可能会选择分叉您的项目或自愿担任维护者或所有者，让您的项目继续前进。您也可以明确要求维护者。

nextstage-brasil / ns-google-utils

维护者

详细信息