Contributing to QuantWeft / 参与 QuantWeft
Thank you for helping improve the explanations, exercises, translations, code and reproducibility. Read LICENSE.md and THIRD_PARTY_NOTICES.md before submitting material.
欢迎改进讲解、练习、翻译、代码和可复现性。提交前请阅读 许可范围 与 第三方声明。
从这里开始 / Start here
提交学习反馈 / Send feedback · 查看已有问题 / Existing issues
小修正可直接提交 PR;较大的结构、依赖或数据改动,先用反馈表单沟通范围。请填写章节位置、实际与预期情况;只有需要复现时才补充运行环境。
Submit a focused PR for a small correction. Discuss scope through the feedback form before larger structural, dependency, or dataset changes. Include the location and actual versus expected result; add environment details only when needed to reproduce the problem.
What to submit / 如何提交
The repository is currently private. GitHub issues and pull requests require an account with repository access. For chapter prose, the paired source files are course/zh/chapters/chNN/content.md and course/en/chapters/chNN/content.md; keep the Chinese and English text aligned where both are affected. Open an issue or a focused pull request with the exact chapter, section, stable exercise ID, or file path; describe the reader problem and proposed correction. Keep code, derivations, units, prerequisites, questions and complete answers consistent. State which checks you actually ran: distinguish text review, independent recalculation, and code or Notebook execution. A successful build alone does not establish teaching or research validity.
仓库目前为私有;提交 GitHub Issue 或 PR 需要账号具有仓库访问权限。章节正文的中英文源文件分别位于 course/zh/chapters/chNN/content.md 和 course/en/chapters/chNN/content.md;涉及两种语言时请保持文字对应。提交 issue 或范围明确的 PR 时,标明章节、节、稳定题号或文件路径,说明读者遇到的问题和拟议修正。保持代码、推导、单位、先修、题目和完整答案一致。说明实际运行的检查,并区分文字检查、独立复算与代码或 Notebook 执行;构建成功本身不能证明教学或研究有效。
Do not upload proprietary or personal data, credentials, unlicensed figures, copied textbook passages or exercises without the required permission, or market data with unverified redistribution terms. Cite sources and identify the exact license and any modifications for third-party material. Discuss new dependencies, datasets and major structural changes before adding them.
请勿提交专有或个人数据、认证信息、无权分发的图片、未经所需许可复制的教材段落或习题,以及再分发权利未核实的市场数据。第三方内容须说明出处、具体许可及修改范围;新增依赖、数据或大规模结构调整先讨论。
Contribution licensing / 贡献许可
By intentionally submitting a contribution for inclusion, you confirm that you have the right to submit it under the applicable project license: MIT for your original software and CC BY-SA 4.0 for your original educational content, with mixed Notebooks split as described in LICENSE.md. Clearly identified third-party components keep their declared licenses and require review. You retain ownership of your contributions; no copyright assignment is requested. Do not submit material subject to incompatible employer, co-author, publisher or data-provider terms.
主动提交供项目收录的贡献时,你确认有权按对应许可提供:原创软件按 MIT,原创教学内容按 CC BY-SA 4.0,混合 Notebook 按根许可说明区分。明确标出的第三方组成部分保留其许可并需复核。贡献者保留版权,无需转让;不得提交与雇主、合著者、出版社或数据方约定冲突的内容。
Review and public release / 审阅与公开
Maintainers review contributions before accepting them. Contributing, sponsorship, and public-release approval are separate decisions. No payment is required for contributions or issue reports. Current public-release blockers are recorded in RIGHTS_REVIEW.md.
维护者审阅后决定收录。贡献接受、赞助和公开发布是不同事项;提问与投稿不要求付费。当前公开前待办见 RIGHTS_REVIEW.md。