跳至主要內容

贡献指南

Zotero Chinese大约 3 分钟

贡献指南

Zotero 中文文档接受多种形式的贡献,请阅读这一份指南,以更快、更有效地参与到文档的维护中。

文档维护的内容和主要方式

文档的维护与更新主要包括几个方面:

  • 修正错别字、语句不通等
  • 修正文档中的错误或不清晰的描述
  • 调整章节结构,使文档条理更清晰
  • 增加示例、专题或入门教程

参与文档的维护的主要方式:

  1. 在 GitHub 上的文档源码仓库下 提交 ISSUEopen in new window
  2. 在 GitHub Zotero Chinese 组织的 Discussions 上讨论open in new window(也可以直接点击文档网页底部的“参与讨论”)
  3. 在网页底部评论区留言
  4. 修改文档源码并提交 Pull Request (不熟悉 Pull Request 的读者可以参考 Pull Request 流程)

提交 / 参与议题 / 讨论

读者可以在前述的几种途径参与讨论。

读者需要一个 GitHub 账户才能提交发起或参与讨论。

修改文档

若只是对文档做简单的微调,比如修改简单的别字、语句不通或不清晰的描述等,可以直接通过 GitHub 在线修改并提交,参阅后文 简单修改

若需要对文档做大量修改,可在经过讨论后,选择 线下修改

文档源码开源托管在 GitHubopen in new window 上,因此读者需要一个 GitHub 账户才能提交 PR。

简单修改

  1. 在线修改

    打开需要修改的文档网页,点击末尾左下角的 “在 GitHub 上编辑此页”,网页会自动跳转到 GitHub 编辑文档源码的页面。

    如果提示需要 fork 才能继续则点击即可。

    编辑需要修改的地方,文档风格和 Markdown 语法请参阅 文档风格指南 #Markdown 语法

  2. 提交修改

    修改完后,在下方的 “Commit changes” 中输入有关此次修改的标题和具体描述。输入一个简短的新分支名字。

    点击 “Commit changes” 提交修改。

  3. 提交 PR

    在 “Open a pull request” 页面中,输入此 PR 的标题和具体描述。点击 “Create pull request” 即可。

    PR 提交后,CI 工具会自动对提交的 PR 生成一个预览链接并评论在 PR 中,可以在此预览修改的结果。

    维护者将尽快审核这些修改。

稍微大量修改

例如你需要添加一篇文章,上传一些图片等,且对 Git 不甚了解,那么可以使用这种方式在线修改,这可以避免你下载很多软件。

请参考 使用 vscode.dev 指南

大量修改

如果你需要做较大量修改,例如增加几篇文章,或长期贡献/维护仓库,可以采用这种方式:完全本地修改,可以在本地预览修改的效果,修改后再推送到 GitHub。

请参考 完全构建指南

注意事项

  • Commit 的注释信息应该是描述性的
  • 希望读者对审稿人/维护者的评论和意见保持开放的心态,并努力改进代码或文档
  • 新的 PR 不一定会及时审核,取决于审稿人/维护者的当时的工作时间