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/elementary-interactive/neon/neon-faq.git
git branch -M main
git push -uf origin main

与您的工具集成

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