Skip to content
Bao Hongchang edited this page Dec 6, 2019 · 4 revisions

如何帮助完善文档

成为 contributor 一起完善文档.

需要具备什么条件:

  • 熟悉 Git
  • 熟悉 Sphinx
  • 拥有一个相对活跃的 Github 账户

需要怎么做:

  1. 使用 fork 克隆这个项目
  2. 在克隆项目里 添加/修改 文档
  3. 在克隆项目提交 commit
  4. 向源提交一个 pull request.

提交 issue 指出文档中的错误疏漏或建议或需求帮助.

需要具备什么条件:

  • 拥有一个 Github 账号

需要怎么做:

  1. 点击 项目标题下方的 Issues;
  2. 阅读是否有类似的 Issue 正在处理中;
  3. 如果没有,则点击 New Issue,并选择合适的标签.

TO-DO Checklist

  • 社区宗旨
  • 在线组卷教程
  • 在线编辑教程
  • 协作编辑教程(历史编辑、审核编辑、合并编辑)
  • BHCexam宏包教程
  • 自定义试题CSS样式教程
  • 一些由用户提交的Howtos,例如:
    • 如何使用 Typora 导入橘子数学试题及解析 离线编写教案
    • 如何自定义 BHCExam 的环境和命令
    • ...