CONTRIBUTE

贡献视觉知识

VisualLex 的数据库就是 Git 仓库本身：每个概念是一个 YAML 文件，每次修订都是一次可追溯的提交。所有贡献通过 Pull Request 进入，经自动校验与 Review 后合并——没有账户系统，社区完全运行在 GitHub 上。

模式 A · 开发者

Fork → 修改 YAML → Pull Request

  1. Fork 仓库并克隆到本地。
  2. 在 data/concepts/ 下新增或修改概念文件，如data/concepts/ethereal.yaml。
  3. 提交 Pull Request，等待自动校验与维护者 Review。

Concept 字段速览

字段说明
id概念唯一标识，kebab-case（如 ethereal）
name中文名称 + 英文名称，双语必填
description中英文描述，双语必填
keywords搜索同义词，zh / en 均需非空
semantic_dimensions语义维度 + 0–100 强度值，详情页 Semantic DNA 的数据来源
visual六个视觉维度（构图 / 光照 / 色彩 / 材质 / 氛围 / 运动）下的 Primitive 列表
positive_evidence正向视觉证据——每条均需填写 zh / en
negative_evidence反向视觉证据——每条均需填写 zh / en
status词条状态（如 draft / stable）
version数据版本号，内容修订时递增
浏览 data/concepts

模式 B · 普通用户

Issue Form，无需写代码

不需要任何 Git 知识：打开 GitHub Issue 表单，描述你想收录或修正的概念，维护者会根据 Issue 整理成 YAML 数据并提交 PR。

  • 概念名称（中 / 英）
  • 概念描述
  • 视觉证据（构图 / 光照 / 色彩 / 材质 / 氛围）
  • 反向证据
  • 参考链接
打开 Issue 表单

Review 流程

贡献内容不会自动进入正式 Dataset。每一条提交都会经过以下六步：

  1. Submission贡献以 Pull Request（开发者）或 Issue（普通用户）形式提交。
  2. Schema Validation自动校验 YAML 结构、字段类型与必填项。
  3. Duplicate Check检查概念是否已收录，或与现有概念语义重复。
  4. Reference Validation校验引用的 Visual Primitive 与关系均真实存在。
  5. Maintainer Review维护者审核内容质量，并统一校准语义强度数值。
  6. Merge合并进入正式 Dataset，随下一次构建自动发布。

PR 自检清单

以下检查会在 CI 中自动执行，提交 Pull Request 前请先在本地自检：

  • Schema Valid — YAML 通过 JSON Schema 校验。
  • ID Unique — 概念 ID 全库唯一，符合命名规范。
  • Relations Valid — 关系类型与方向合法。
  • No Broken References — 引用的概念与 Primitive 均已存在，无悬空引用。
  • Keywords Present — keywords 中英文均非空。
  • Build Pass — pnpm build 构建通过。

参与讨论

新词提案、视觉研究、Prompt 实验与项目建议，欢迎先到 GitHub Discussions 讨论，再决定是否进入正式数据：

前往 GitHub Discussions

本地开发速览

pnpm install   # 安装依赖
pnpm dev       # 启动本地开发服务器
pnpm validate  # 校验 data/ 下的 YAML 数据
pnpm test      # 运行单元测试