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://git.customd.com/composer/customd-laravel-installer.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](https://git.customd.com/composer/customd-laravel-installer/-/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中，你可能看到一些小的图像，传达元数据，例如项目的所有测试是否都通过。你可以在README中添加一些徽章。许多服务也提供了添加徽章的说明。

视觉元素

根据你正在制作的内容，包含截图甚至视频（你通常会看到GIF而不是实际的视频）是一个好主意。ttygif等工具可以帮助，但也可以查看Asciinema以获得更复杂的方法。

安装

在特定的生态系统中，可能有一种通用的安装方式，例如使用Yarn、NuGet或Homebrew。但是，考虑到阅读你的README的人可能是一个新手，并且希望获得更多指导。列出具体的步骤有助于消除歧义，并尽快让人们使用你的项目。如果它仅在特定的环境中运行（如特定的编程语言版本或操作系统）或需要手动安装的依赖项，也可以添加一个“需求”子部分。

使用

广泛使用示例，并在可能的情况下显示预期的输出。如果你能提供尽可能小的使用示例，这会很有帮助，同时如果它们太长而无法合理地包含在README中，也提供链接到更复杂的示例。

支持

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

路线图

如果你对未来发行版有想法，将其列在README中是一个好主意。

贡献

说明你是否愿意接受贡献以及接受它们的要求。

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

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

作者和致谢

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

许可证

对于开源项目，说明它的许可证。

项目状态

如果你已经没有精力或时间继续你的项目，在README的顶部添加一条说明，说明开发已经放缓或已完全停止。有人可能会选择分叉你的项目或志愿担任维护者或所有者，从而使你的项目继续进行。你还可以明确要求维护者。

cd-laravel / installer

维护者

详细信息