README

Curator Drupal 9 和 curator 系统的自定义模块

入门指南

为了使您更容易开始使用 GitLab，以下是一些推荐的下一步操作。

已经是专家？只需编辑此 README.md 并使其成为您自己的。想要更容易？使用底部的模板！

添加您的文件

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

与您的工具集成

[ ] [设置项目集成](https://gitlab.com/-/experiment/new_project_readme_content:16f5b25b2542223b35b67eeb12e0bd3a?https://docs.gitlab.com/ee/user/project/integrations/)

与您的团队协作

[ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:16f5b25b2542223b35b67eeb12e0bd3a?https://docs.gitlab.com/ee/user/project/members/)
[ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:16f5b25b2542223b35b67eeb12e0bd3a?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
[ ] [合并请求成功时自动关闭问题](https://gitlab.com/-/experiment/new_project_readme_content:16f5b25b2542223b35b67eeb12e0bd3a?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
[ ] [管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:16f5b25b2542223b35b67eeb12e0bd3a?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:16f5b25b2542223b35b67eeb12e0bd3a?https://docs.gitlab.com/ee/ci/quick_start/index.html)
[ ] [使用静态应用程序安全测试(SAST)分析您的代码以查找已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:16f5b25b2542223b35b67eeb12e0bd3a?https://docs.gitlab.com/ee/user/application_security/sast/)

编辑此 README

当你准备好将此README变为自己的时，只需编辑此文件并使用下方的便捷模板（或者你可以自由地组织结构 - 这只是一个起点！）感谢 makeareadme.com 提供的此模板。

良好的README建议

每个项目都不同，因此请考虑哪些部分适用于您的项目。模板中使用的部分是大多数开源项目的建议。此外，请记住，虽然README可能太长且详细，但过长总比过短好。如果您认为您的README过长，考虑使用其他形式的文档，而不是删除信息。

名称

为您的项目选择一个易于理解的名称。

描述

让人们知道您的项目具体能做什么。提供上下文，并添加链接到任何可能不熟悉的参考内容。也可以在此处添加功能列表或背景子部分。如果您的项目有替代品，这是一个列出不同之处的好地方。

徽章

在一些README中，您可能会看到传达元数据的小图像，例如项目是否所有测试都通过。您可以使用Shields添加一些到您的README。许多服务也提供了添加徽章的说明。

视觉元素

根据您正在制作的内容，包含截图甚至视频（您通常会看到GIF而不是实际视频）。像ttygif这样的工具可以帮助，但请查看Asciinema以获得更复杂的方法。

安装

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

用法

自由使用示例，并在可能的情况下展示预期的输出。如果您可以展示最小的用法示例，同时提供链接到更复杂的示例（如果它们太长，不适合合理包含在README中），这会很有帮助。

支持

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

路线图

如果您对未来发布有想法，将其列入README是一个好主意。

贡献

说明您是否欢迎贡献以及接受贡献的要求。

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

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

作者和致谢

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

许可

对于开源项目，说明其许可方式。

项目状态

如果你的项目能量或时间耗尽，请在README顶部添加一条注释说明开发已放缓或完全停止。有人可能会选择分支你的项目或自愿成为维护者或所有者，让项目继续进行。你还可以明确请求维护者。

kwall / curator

维护者

详细信息