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]: 改造文档「元素 - 节点 - 使用 React 定义节点」 #6915

Open
yvonneyx opened this issue Mar 19, 2025 · 2 comments
Open
Assignees
Labels
documentation 📖 Improvements or additions to documentation OSCP

Comments

@yvonneyx
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!

改造文档「元素 - 节点 - 使用 React 定义节点」

任务介绍

能力要求

- 对 G6 有深入了解,能阅读 G6 源码,编写示例。

执行路径

1. 认领任务

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

  • 认领回复格式:【@github ID + Give it to me】
  • eg:【@yvonnyx Give it to me】

2. 做任务

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

对应文件位于 packages/site/docs/manual/element/node/react-node.zh.md

3. 提交 PR

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

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

Image

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

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

@yvonneyx yvonneyx added OSCP documentation 📖 Improvements or additions to documentation labels Mar 19, 2025
@yvonneyx yvonneyx moved this to Need Triage in 2025 AntV OSCP Season of Docs Mar 19, 2025
@liaodalin19903
Copy link
Contributor

@yvonnyx Give it to me

@yvonneyx
Copy link
Contributor Author

👋 @liaodalin19903 , 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! 😄

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

@yvonneyx yvonneyx moved this from Need Triage to In Progress in 2025 AntV OSCP Season of Docs Mar 25, 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 OSCP
Projects
Status: In Progress
Development

No branches or pull requests

2 participants