README

EDU Drupal 9 的初始安装

入门指南

为了帮助您快速开始使用 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/kwall-edu.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中，您可能看到一些小图像，传达元数据，例如项目是否所有测试都通过。您可以使用盾牌为您的README添加一些。许多服务也提供了添加徽章的说明。

视觉元素

根据您所制作的，包含截图甚至视频（您通常会更频繁地看到GIF而不是实际视频）可能是个好主意。ttygif等工具可以帮助，但请查看Asciinema以获得更复杂的方法。

安装

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

使用

广泛使用示例，并在可能的情况下显示预期的输出。尽可能提供可展示的最小使用示例，同时提供链接到更复杂的示例，如果它们太长而不适合合理包含在README中。

支持

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

路线图

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

贡献

声明您是否接受贡献以及接受贡献的要求。

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

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

作者和致谢

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

许可协议

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

项目状态

如果您已经耗尽了精力或时间来完成您的项目，请在README顶部注明开发已经放缓或完全停止。有人可能会选择分叉您的项目，或自愿担任维护者或所有者，以使项目继续进行。您也可以明确要求维护者。

kwall / kwall-edu

维护者

详细信息