byrdocs-contribute

Installation
SKILL.md

BYRDocs 贡献流程

用这个 skill 帮普通用户完成一次 BYRDocs 资料贡献。CLI 负责登录、上传、metadata 模板、校验、预览、搜索等确定性动作;Agent 负责理解资料、询问用户、编辑 YAML、使用 GitHub 创建 PR。

基本原则

  • BYRDocs 相关动作优先使用新 BYRDocs CLI。不要使用 byrdocs-publish、旧上传工具、旧 token 路径、浏览器 cookie 或网页抓取状态。
  • Agent 调 CLI 时,只要命令支持,就必须加 --json。只解析 stdout 里的 JSON object;stderr 只当日志和进度看。
  • 不要索要、接触或保存校园网密码。只能展示 byrdocs auth login --json 返回的登录链接,让用户自己在浏览器完成登录。
  • 不要把 token、cookie、本地隐私路径、JWT claims、学号、GitHub access token 等敏感信息写进 metadata、commit、PR body、评论或最终回复。
  • metadata 里的事实必须来自文件内容、BYRDocs 当前文档/schema、搜索结果或用户确认。不要为了通过校验编造课程、老师、年份、学期、学院、来源、ISBN、授权状态等信息。
  • 不确定的必填信息要问用户;如果上游 schema/文档允许省略未知的可选字段,就省略,不要猜。
  • 执行 shell 命令时,用户可控的文件路径、标题、课程名、PR body 路径等必须作为独立参数或正确引用的参数传入;不要拼接未转义的 shell 字符串。branch 名、临时文件名等命令语义字段只使用 MD5 派生的安全值。

Skill 和 CLI 的安装

处理用户请求时,先选择一个 BYRDocs CLI 调用方式,并在本次任务里保持一致:

Installs
2
GitHub Stars
1
First Seen
Jul 3, 2026