参与贡献

April 11, 2026 · View on GitHub

感谢你为 professor-skill 提交改进。

这个项目目前仍处于 beta 阶段。相比大而泛的改造，更欢迎小而具体、能直接提升可用性和观感的改动。

适合优先贡献的方向

  • 补 README、示例或截图，让项目更容易看懂
  • 增加一个公开安全的示例课程
  • 提升 pdf / pptx / docx 的抽取质量
  • 在不夸大能力边界的前提下，改进生成结果质量
  • 为构建链路补充边界测试

提交 PR 前请先确认

  1. 保持项目是 review-first，而不是泛化成普通 AI tutor
  2. 不要在 README 或代码里声明项目尚未真正支持的能力
  3. 除非确实带来明显价值，否则不要引入过重依赖
  4. 不要破坏 README.md 和 SKILL.md 中的法律、版权和隐私边界
  5. 如果改动了构建链路，请先跑一遍 smoke test

本地检查

python -m pip install -r requirements.txt
python tools/smoke_test.py

改动范围建议

  • 优先使用公开安全的材料和示例
  • 优先做确定性的质量提升，而不是只改 prompt 话术
  • 优先提交边界清晰、目标明确的小 PR

PR 写法建议

  • 标题尽量简短直接
  • 说明这次改动对用户有什么实际影响
  • 如果改了 README、示例或生成结果，请在描述里注明
  • 如果引入了新依赖，请说明为什么有必要