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

与您的工具集成

• [ ] [设置项目集成](https://gitlab.com/fairwinds/iotcatalystcloudfunctions/-/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顶部注明开发已放缓或完全停止。有人可能会选择分支您的项目或自愿担任维护者或所有者，使项目得以继续。您还可以明确请求维护者。