Skip to content

Latest commit

 

History

History
81 lines (52 loc) · 2.38 KB

File metadata and controls

81 lines (52 loc) · 2.38 KB

Contributing

English · 简体中文

感谢你帮助改进 DevGraph 开放技能图谱。

修改哪里

大多数贡献只需要修改:

graphs/{graphSlug}/payload.json

然后运行:

npm run generate
npm run validate

生成文件包括:

  • graphs/{graphSlug}/index.json
  • graphs/{graphSlug}/README.md
  • graphs/{graphSlug}/index.en-US.md
  • graphs/{graphSlug}/index.zh-CN.md

不要手工修改生成文件来调整目录、排序或语言文档。请在 payload.json 中修改双语内容、节点层级或 sortOrder,然后重新生成。

内容许可

本仓库中的图谱内容是源码可见内容,仅供个人、非商业学习和贡献使用。不要把它复制进商业产品、公开镜像、托管数据集、API、搜索索引、RAG 系统、模型训练集、课程、书籍、newsletter 或其他衍生服务。

提交贡献即表示你确认自己有权贡献这些内容,内容未复制自许可不兼容的来源,并且你授予 DevGraph 永久、不可撤销、全球范围、免版税、可转让、可再许可的权利,用于在 DevGraph 产品、服务、网站、仓库和内容工作流中使用、复制、修改、翻译、发布、展示、分发和商业化你的贡献。

公开用户只能按照本仓库 LICENSE 使用已贡献的图谱内容。如果你不能授予 DevGraph 上述权利,请不要提交相关内容。

节点规范

每个节点应包含:

  • 稳定的 slug
  • 合法的 parentSlug
  • 分类:core、common 或 rare
  • 数字类型的 sortOrder
  • 英文和中文内容
  • 简洁摘要,解释概念本身,而不只是重复标题

rare 用于较低频或更进阶的主题,官方只读预览中默认会隐藏这类节点。

变更理由

PR 应说明为什么新增、修改或删除节点。这个理由属于 review 上下文,不应写进 payload.json。

PR body 可使用这个结构:

Added nodes:
- node-slug: Why this concept belongs in the graph.

Changed nodes:
- node-slug: What changed and why it improves the graph.

Removed nodes:
- node-slug: Why the graph is clearer without this node.

官方预览

图谱同步后,官方只读预览地址是:

https://devgraph.dev/open/graphs/{graphSlug}

完整学习工作区地址仍然是:

https://devgraph.dev/graphs/{graphSlug}