跳转至

贡献指南(Contributing Guide)

感谢你愿意为《预测市场入门指南》做出贡献!本项目以开源协作为核心,欢迎增补章节、修订表述、完善术语与参考文献、添加图示与案例来源。

许可与版权

  • 本项目采用 CC BY-SA 4.0(署名-相同方式共享)协议(见 LICENSE)。
  • 你提交的内容默认按相同协议进行授权;请确保拥有相应版权或已获得授权。

如何贡献

  1. Fork 仓库并创建分支:feature/...fix/...
  2. 在本地修改相关 Markdown 文件(章节或附录)
  3. 自检(见下文)并提交 PR(Pull Request)
  4. 等待编辑与维护者评审;CI 通过后合并

内容结构

  • 章节文件位于仓库根目录:
  • 前言.md大纲.md
  • chapter_01.mdchapter_10.md
  • 术语指南.md参考文献.md全书总结页.md致谢.md
  • 附录A.md附录B.md附录C.md
  • 站点配置:mkdocs.yml(导航、主题、插件)
  • 部署工作流:.github/workflows/gh-pages.yml

写作规范

  • 标题与层级:统一使用 ###### 层级;章标题统一格式(例如“第 4 章|参与实战”)
  • 语言风格:简洁、准确、面向读者;避免过度口语化与未验证断言
  • 术语与排版:中英文间留空格;半角标点;统一术语拼写(维护于 术语指南.md
  • 引用与来源:在正文加简要出处,并在 参考文献.md 补充条目(作者-年份或权威链接)
  • 图表与示意:放置于相应章节并描述来源或版权;SVG/PNG 均可

提交前自检清单

  • 文稿通读无错字、术语一致、标题层级正确
  • 新增/修改内容是否在 大纲.md 或导航中可定位(如涉及章节结构调整)
  • 参考资料是否加入 参考文献.md
  • 本地预览是否可构建:
  • 安装:pip install mkdocs mkdocs-material
  • 预览:mkdocs serve(默认 http://127.0.0.1:8000 )

PR 建议模板

  • 修改类型:新增章节 / 修订段落 / 术语补充 / 参考文献 / 图示
  • 修改范围:文件列表(如 chapter_04.md参考文献.md
  • 变更说明:动机与效果简述
  • 自检结果:构建通过 / 链接可用 / 风格一致

评审与合并

  • 至少 1–2 名维护者或编辑批准后合并
  • CI 通过(MkDocs 构建)方可合并;若断链或构建失败,请修复后重试

行为准则

  • 尊重多元观点与专业表达;拒绝人身攻击或歧视
  • 专注事实与可验证信息;明确假设与边界

联系与讨论

  • 提交 Issue:用于问题反馈、改进建议、选题讨论
  • 讨论区(如开启):用于长期话题与选题投票

期待你的贡献!让预测市场知识成为人人可协作的公共资源。