贡献者须知

[boxizen]

01 发现任务

仓库下有打了 help wanted 的 label 的 issue，是经过团队筛选认为当前优先级比较高、能够复现的 Bug 或是正招募贡献者参与的 feature，看官们可以点击该标签筛选出所有 help wanted 的 issue，当前优先级较高的 issue 主要围绕了如下所示的 用户体验、项目基建和特性支持三个维度，欢迎各位领取开发

02 提交PR

02-1 Fork 仓库

02-2 同步代码

建议在每次提交本地代码之前都从上游仓库同步最新代码，否则可能需要额外处理很多冲突。GitHub 提供了在页面上操作同步上游仓库的功能：

但推荐在 clone 仓库至本地后通过添加 upstream 的方式来关联远端上游仓库：

$ git remote add upstream https://github.com/onepointAI/onepoint.git
$ git remote -v
> origin    [email protected]:${USER}/${PROJECT}.git (fetch)
> origin    [email protected]:${USER}/${PROJECT}.git (push)
> upstream    https://github.com/onepointAI/onepoint.git (fetch)
> upstream    https://github.com/onepointAI/onepoint.git (push)

这样可直接本地通过如下方式将 upstream 官方仓库的改动同步到本地：

git fetch upstream
git rebase upstream/main

02-3 创建分支

同步官方仓库代码之后，请从 main 分支创建新的 feat/fix 分支：

git checkout main
git checkout -b feat/xxx

02-4 开发与提交

本地开发的时候注释与文字用英语哈，因为后续要做i18n，英语的话方便后面做映射～

本地开发完成后，需要执行 yarn format 及 yarn format-check 保证结果通过(你不执行husky也会在你commit前默认执行的嘿嘿)。

另 commit-msg 请遵循 Angular Commit 规范，如下：

feat：新功能
fix：修补 bug
docs：文档类变动
style：样式
refactor：重构
test：增加测试
chore：构建过程或辅助工具的变动

02-5 发起PR

在你主页 fork 的项目中发起 PR

03 开发者激励

提交 PR 后团队会跟进合并请求，当所有 Review 与 CI 通过后你将在项目主页上看到自己靓靓的照片 🎉

同时，项目方有发行OnePoint NFT，团队会在每个周期（项目初期约定为一周）定时统计开发者的贡献量，为其量身定制 AVATAR NFT 一枚并免费赠与，NFT 形象如下，根据你所提供的照片定制：