首先为你选择加入开源贡献行列的行为点赞 👍🏻。再者,十分感谢你选择参与到 VisActor 社区,为这个开源项目做出贡献。
VisActor 团队通常在 github 上进行开发和 issue 维护,请打开 Github 网站,点击右上角 Sign up
按钮,注册一个自己的账号,开启你开源之旅的第一步。
如果因为特殊情况,你无法打开 Github 站点,请告知我们并通过 Gitee 进行项目开发。
在 VChart 仓库中,我们有一份面向所有开源贡献者的指南,介绍了有关版本管理、分支管理等内容,请花几分钟时间阅读了解一下。
Git 是一种版本控制系统,用于跟踪和管理软件开发项目中的代码变更。它帮助开发者记录和管理代码的历史记录,方便团队协作、代码版本控制、合并代码等操作。通过 Git,您可以追踪每个文件的每个版本,并轻松地在不同版本之间进行切换和比较。Git 还提供了分支管理功能,使得可以同时进行多个并行开发任务。
git version
命令确认安装成功。// ssh
git clone git@github.com:xxxx(你的github用户名)/VChart.git
// https
git clone https://github.com/xxxx(你的github用户名)/VChart.git
git remote add upstream https://github.com/VisActor/VChart.git
git pull upstream develop
// 创建功能开发分支
git checkout -b feat/xxxx
// 创建问题修复开发分支
git checkout -b fix/xxxx
// 创建文档、demo分支
git checkout -b docs/add-funnel-demo
假设我们创建了文档修改分支 docs/add-funnel-demo
现在我们可以在分支上更改代码了
假设我们已经添加了一些代码,提交到代码库
git commit -a -m "docs: add custom funnel demo and related docs" 。VisActor 的 commit 提交信息遵循 Conventional Commits 规范
<type>[optional scope]: <description>
type
包括 docs(文档、日志修改)、feat(新功能)、fix(问题修复)、refactor(代码重构)等,请根据实际情况选择。git checkout develop
git pull upstream develop
git checkout docs/add-funnel-demo
git rebase develop
git push origin docs/add-funnel-demo
你可以在你的 github 代码仓库页面点击 Compare & pull request
按钮。
或通过 contribute
按钮创建:
按照模板填写本次提交的修改内容:
相关信息填写完成后,点击 Create pull request 提交。
"good first issue" 是一个在开源社区常见的标签,这个标签的目的是帮助新贡献者找到适合入门的问题。
VChart 的入门问题,你可以通过 issue 列表 查看,目前包括两类:
如果你当前有时间和意愿参与到社区贡献,可以在 issue 里看一看 good first issue,选择一个感兴趣、适合自己的认领。
相信你一定是一个有始有终的同学,所以,当你了解并决定认领一个 issue 后,请在 issue 下留言告知大家。
我们准备了一些在实际应用场景中常见的案例,需要思考如何利用 VChart 的能力实现。
你可以通过这类任务,上手对 VChart 的使用。VChart 提供了丰富的能力,每个人或许都有不同的实现思路,你可以在 issue 下留言,和大家讨论自己的方案。
任务完成后,你可以将自己制作的案例提交到官网 demo,让更多需要的人学习和使用。
所有的 demo 存放在 docs/assets/examples
目录下
docs/***
或 demo/***
分支进行开发npm i --global @microsoft/rush
rush update
rush docs
在本地预览目前 demo 内容docs
目录下:
docs/assets/examples/menu.json
目录文件中添加你的 demo 信息zh
/en
目录下分别完成中英文 demo 文档docs/public/vchart/preview
目录下添加 demo 预览图片并将相对路径更新在 demo 文档中我们准备了一些简单、易上手的特性开发任务,如果你有一定的 Javascript / Typescript 基础,可以认领这类任务。
你可以通过需求开发,更快地了解 VChart 代码架构。你可以在 issue 下留言,和大家讨论自己的方案。
feat/***
分支进行开发npm i --global @microsoft/rush
rush update
rush start
在本地运行 VChart 代码的测试页面
develop/packages/vchart/__tests__/runtime/browser
下创建 index.page.local 页面,引入自己创建的开发用例rush test
rush change
命令,编写 changelog 并提交在你为 VisActor 贡献代码之余,我们鼓励你参与其他让社区更加繁荣的事情,比如:
VisActor 也在努力帮助参与社区建设的同学一同成长,我们计划(但不限于,期待大家更多的建议)提供如下帮助:
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。