Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs]: 改造文档「核心概念 - 数据(Data)- sort」 #6672

Open
interstellarmt opened this issue Mar 19, 2025 · 0 comments
Open
Labels
documentation 📖 Improvements or additions to documentation good first issue Good for newcomers OSCP AntV Open Source Contribution Plan

Comments

@interstellarmt
Copy link
Contributor

interstellarmt commented Mar 19, 2025

任务介绍

此 ISSUE 为 AntV 开源共建计划(AntV Open Source Contribution Plan,简称 AntV OSCP)Phase3 - 文档季的任务 ISSUE,欢迎社区开发者参与共建~

This ISSUE is one of the tasks of the AntV Open Source Contribution Plan (referred to as AntV OSCP) Pharse3 - Season of Docs . Welcome to join us in building it together!

改造文档「核心概念 - 数据(Data)- sort」

任务介绍

详细要求

  • 文档规范:
    • 参考示例:
    • 文档结构:「数据」部分的文档至少应该包括 概述配置项使用场景示例 几个部分。
    • 代码规范:示例代码统一使用 spec 语法。即 chart.options({}),可以在图表示例页面完成切换。
    • 内容规范:
      • 属性表格需要包含【属性】【描述】【类型】【默认值】【必选】列,所有的配置项包括绘图属性需要罗列完整。
      • 复杂类型单独解释说明
      • 必要时可配上示意图

能力要求

- 对 G2 有一定了解,能阅读 G2 源码,编写示例。

执行路径

1. 认领任务

选择感兴趣的且没有 Assignee 的任务,按格式回复,该任务 assign 给你后即为成功认领~

2. 做任务

  1. clone g2 代码
git clone https://github.com/antvis/G2.git
  1. 拉取所有线上分支
git fetch
  1. 切换到 v5 分支
git checkout v5
  1. 安装依赖
pnpm install
  1. 进入 site 包
cd site
  1. 安装 site 依赖
pnpm install
  1. 本地启动 site 站点
pnpm run start
  1. 优化文档并预览效果

对应文件位于 site/docs/manual/xxx.zh.md

3. 提交 PR

请保证文档语意通顺、格式正确、代码示例完整且能够正确编译,否则该 PR 将不会被 review 和 merge,此 issue 将被重新释放。

  1. 提交 Pull Request,等待 Code Review
  • PR 标题参考 docs: 任务名称 ,如 docs: 改造「核心概念 - 标记(Mark)-wordCloud」文档 ,并关联 OSCP 标签,以便快速进入 PR review 阶段。
  • PR 与对应任务 ISSUE 进行关联,方式:在 PR 正文中,通过 - Fixed: #任务 ISSUE 号 即可实现关联,eg:

Image

  1. 根据(多次) Code Review 建议修改

3 等待合并入 v5 分支后,积分生效

@interstellarmt interstellarmt added OSCP AntV Open Source Contribution Plan documentation 📖 Improvements or additions to documentation labels Mar 19, 2025
@antvis antvis deleted a comment from petercat-assistant bot Mar 20, 2025
@interstellarmt interstellarmt added the good first issue Good for newcomers label Mar 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📖 Improvements or additions to documentation good first issue Good for newcomers OSCP AntV Open Source Contribution Plan
Projects
Status: Need Triage
Development

No branches or pull requests

1 participant