8000 [Docs]: 改造文档「核心概念 - 坐标系（Coordinate）-parallel」 · Issue #6850 · antvis/G2 · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[Docs]: 改造文档「核心概念 - 坐标系（Coordinate）-parallel」 #6850

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.

Sign up for GitHub

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

Jump to bottom
Closed
interstellarmt opened this issue May 9, 2025 · 2 comments · Fixed by #6891
Closed

[Docs]: 改造文档「核心概念 - 坐标系（Coordinate）-parallel」 #6850

interstellarmt opened this issue May 9, 2025 · 2 comments · Fixed by #6891
Assignees
@pengcai6
Labels
documentation 📖 Improvements or additions to documentation good first issue Good for newcomers OSCP AntV Open Source Contribution Plan

Comments

@interstellarmt
Copy link
Contributor

任务介绍

此 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!

改造文档「核心概念 - 坐标系（Coordinate）-parallel」

任务介绍

详细要求

  • 文档规范：
    • 参考示例：
    • 文档结构：「比例尺」部分的文档至少应该包括 概述、配置项，示例 几个部分，如果必要的话概述部分需要介绍经常使用该坐标系的标记
    • 代码规范：示例代码统一使用 spec 语法。即 chart.options({})，可以在图表示例页面完成切换。
    • 内容规范：
      • 属性表格需要包含【属性】【描述】【类型】【默认值】【必选】列，所有的配置项包括绘图属性需要罗列完整。
      • 默认值除了功能实现部分，还可能配置在主题里 src/theme/create.ts
      • 复杂类型单独解释说明
      • 必要时可配上示意图

能力要求

- 对 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/core/coordinate/parallel.zh.md
  • 功能实现位于 src/coordinate/parallel.ts
  • 图表示例位于：site/examples/xxx/xxx/demo，可以在该文件夹下搜索

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 good first issue Good for newcomers labels May 9, 2025
@pengcai6
Copy link
Contributor

@pengcai6 Give it to me

@interstellarmt
Copy link
Contributor Author

👋 @pengcai6 , just a friendly reminder to submit your contributions within 7 days! If no updates are made within this timeframe, the issue will be reassigned to others. Let us know if you have any questions! 😄

你好 @pengcai6 ，恭喜你成功认领任务！请在 7 天内完成贡献哦～如果超时未提交，任务将会被重新分配。如有任何疑问，欢迎随时联系我们！😄

@interstellarmt interstellarmt moved this from Need Triage to In Progress in 2025 AntV OSCP Season of Docs May 19, 2025
This was referenced May 19, 2025
Closed
Closed
Merged
@github-project-automation github-project-automation bot moved this from In 72EE Progress to Done in 2025 AntV OSCP Season of Docs May 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pengcai6 pengcai6

Labels
documentation 📖 Improvements or additions to documentation good first issue Good for newcomers OSCP AntV Open Source Contribution Plan
Projects
2025 AntV OSCP Season of Docs
Status: Done
Milestone
No milestone
2 participants
@pengcai6 @interstellarmt
0