Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

36 lines (22 loc) · 2.08 KB

参与贡献

非常感谢您能考虑参与本知识库的建设,也很感谢您能在开始贡献之前阅读该指南!

如何贡献

已经有了一些想法吗?贡献不一定需要实打实地编辑内容并提交修改,以下是一些参与贡献的方式:

  1. 您可以在 Issue 中指出错误、遗漏等问题,完善文档;
  2. 如果您有一些想法或想要讨论剧情,可以在讨论区或文档下方评论区展开话题,有利于活跃社区气氛;
  3. 准备开始编写文档了的话,您可以先发起一个 Issue 描述您将要进行的编辑工作,而后再进行 Pull Request,以免其他贡献者与您的工作产生冲突。

本地构建

如果您想开始编辑的话,最好在本地也能够预览文档的渲染效果。在自述文件(README.md)中有简单的本地部署执行操作,以下是更加详细的步骤:

  1. 安装 Node(可以前往官方网站,或通过你系统的包管理器安装),安装完成后安装 pnpm

  2. 接着您需要 clone 本仓库或您的 fork 分支(最好是使用您的 fork);

  3. 在仓库目录下,通过终端执行以下命令:

    pnpm install
    pnpm start
  4. 接着您就能看到文档的即时浏览网页了。

编辑

编辑、组织乃至修改文档都不是一件易事,但我们相信,只要有爱就一定能行。

但烦请确保您的文档符合行为守则和编辑规范。您的编辑如有排版、标点符号上的问题,这无关紧要,我们会帮助您完善这些细节。但首先您得确保您的语气要保持中立,如果您想在文档中展开对剧情的讨论或涉及后续情节透露,请在文档开头添加「剧透」提示;如果您对剧情的分析、出典考据仍感到疑惑,可在文档开头添加「存疑」提示(详见准则)。

合并

凡是 Writer Team 成员都可以在审核后,合并 PR 到主分支,CI 将会自动构建网页发布。