README

basin项目使用的Drupal项目的常见设置。依赖于其他常见设置，如mariadb、redis、devel等。

入门指南

为了使您更容易开始使用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/upstreamable/drupal-settings-basin.git
git branch -M main
git push -uf origin main

集成您的工具

[ ] [设置项目集成](https://gitlab.com/upstreamable/drupal-settings-basin/-/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顶部注明开发已减慢或完全停止。有人可能选择分叉您的项目或志愿成为维护者或所有者，使项目继续进行。您还可以明确请求维护者。

upstreamable / drupal-settings-basin

维护者

详细信息