README

Drupal 开发依赖

入门

为了使您在 GitLab 中开始使用更加容易，以下是一份推荐的操作步骤列表。

已经是专业人士？只需编辑此 README.md 并将其变为您的专属。想要让它变得容易？使用底部的模板！

添加您的文件

[ ] [创建](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) 或上传文件
[ ] [使用命令行添加文件](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?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/druparcheky/core-dev.git
git branch -M main
git push -uf origin main

集成您的工具

[ ] [设置项目集成](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://gitlab.com/druparcheky/core-dev/-/settings/integrations)

与您的团队协作

[ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/user/project/members/)
[ ] [创建一个新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
[ ] [从合并请求中自动关闭问题](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
[ ] [启用合并请求批准](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
[ ] [当管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)

测试和部署

使用 GitLab 内置的持续集成。

[ ] [开始使用 GitLab CI/CD](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/ci/quick_start/index.html)
[ ] [使用静态应用程序安全测试(SAST)分析您的代码以查找已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/user/application_security/sast/)
[ ] [使用自动部署部署到Kubernetes、Amazon EC2或Amazon ECS](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
[ ] [使用基于拉取的部署来改进Kubernetes管理](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?https://docs.gitlab.com/ee/user/clusters/agent/)
[ ] [设置受保护的环境](https://gitlab.com/-/experiment/new_project_readme_content:32d90d0fbe7a58eb279c4b54245bd5c5?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的顶部注明开发速度放缓或已完全停止。有人可能会选择分支您的项目，或者自愿成为维护者或所有者，使您的项目能够继续进行。您还可以明确要求维护者。

druparcheky / core-dev

维护者

详细信息