Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (52 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

81 lines (52 loc) · 2.53 KB
Raw

Contributing

English · 简体中文

Thanks for helping improve the DevGraph open skill graphs.

What To Edit

For most changes, edit only:

graphs/{graphSlug}/payload.json

Then run:

npm run generate
npm run validate

Generated files:

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

Do not hand-edit generated files to fix the table of contents or localized docs. Change bilingual content, node hierarchy, or ordering in payload.json instead.

Content License

Graph content in this repository is source-available for personal, non-commercial learning and contribution only. Do not copy it into commercial products, public mirrors, hosted datasets, APIs, search indexes, RAG systems, model training sets, courses, books, newsletters, or other derivative services.

By submitting a contribution, you confirm that you have the right to contribute it, that it is not copied from a source with incompatible terms, and that you grant DevGraph a perpetual, irrevocable, worldwide, royalty-free, transferable, sublicensable license to use, reproduce, modify, translate, publish, display, distribute, and commercialize your contribution as part of DevGraph products, services, websites, repositories, and content workflows.

Public users receive access to contributed graph content only under the repository LICENSE. Do not submit content if you cannot grant DevGraph the rights above.

Node Guidelines

Each node should have:

  • a stable slug
  • a valid parentSlug
  • a category: core, common, or rare
  • a numeric sortOrder
  • English and Chinese content
  • a concise summary that explains the concept, not only the label

Use rare for lower-frequency or advanced topics that should be hidden by default in the official preview.

Change Rationale

PRs should explain why nodes were added, changed, or removed. This rationale is review context and should not be written into payload.json.

Use this shape in the 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.

Official Preview

After a graph is synced, the official read-only preview is available at:

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

The full learning workspace remains:

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