Skip to content

[Docs]: 新增文档「图表组件-统计图表-瀑布图(Waterfall)」 #2944

@lxfu1

Description

@lxfu1

任务介绍

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

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

任务介绍

  • 任务名称:新增 瀑布图 文档
  • 技术方向:Ant Design Charts / docs
  • 任务难度:新手友好 🌟
  • 可获得积分:20分

详细要求

  • 文档规范:
    • 参考示例:
    • 文档结构:文档至少应该包括 简介代码演示配置项事件方法常见问题 几个部分。
    • 文档内容:
      • 简介:简要介绍该图表的功能和特点。
      • 代码演示:尽可能多的覆盖该图表配置,展示如何使用该图表,示例代码统一放到 examples/[statistics|relations] 目录下,通过 Playground 引入即可。
      • 配置项:详细列出所有可配置的属性及其说明,参考 G2G6
      • 事件:列出该图表支持的事件及其触发条件(必要时补充添加核心代码)。
      • 方法:列出该图表支持的方法及其功能,已经在图表方法中的给跳转链接即可。
      • 常见问题(可选):列出一些常见问题及其解决方案。
    • 注意事项:
      • 属性表格需要包含【属性】【描述】【类型】【默认值】【必选】列,所有的配置项包括绘图属性需要罗列完整。
      • 示例代码无需关心图表示例缩略图问题,后续统一上传。
      • 认领关系图的同学,需要将 site/docs/components/graphs-demos 中对应的示例先迁移到 site/examples/relations 目录下。

能力要求

- 对 G2、G6 有一定了解,能阅读 Ant Design Charts 源码,编写示例。

执行路径

1. 认领任务

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

2. 做任务

  1. clone charts 代码
git clone https://github.com/ant-design/ant-design-charts.git
  1. 拉取所有线上分支
git fetch
  1. 切换到 v2 分支
git checkout v2
  1. 安装依赖
pnpm install
  1. build lib
pnpm run build:lib
  1. 本地启动 site 站点
pnpm start
  1. 优化文档并预览效果
  • 对应文件位于 site/docs/components/plots/xxx.zh.mdsite/docs/components/graphs/xxx.zh.md
  • 功能实现位于 packages/xxx/xxx.ts
  • 图表示例位于:site/examples/xxx/xxx/demo
    // - 图表示例暂无 欢迎补充👏

3. 提交 PR

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

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

Image

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

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions