Skip to content

贡献指南

Sunil Wang edited this page May 30, 2022 · 1 revision

贡献

这篇指南会指导你如何为 Picasso 贡献一份自己的力量,请在你要提 issue 或者 pull request 之前花几分钟来阅读一遍这篇指南。

行为准则

我们有一份 行为准则,希望所有的贡献者都能遵守,请花时间阅读一遍全文以确保你能明白哪些是可以做的,哪些是不可以做的。

透明的开发

我们所有的工作都会放在 GitHub 上。不管是核心团队的成员还是外部贡献者的 pull request 都需要经过同样流程的 review。

分支管理

我们长期维护两个分支 master 和 feature。如果你要修一个 bug,那么请发 pull request 到 master,我们会每周从 master 发布一个 patch 版本;如果你要提一个增加新功能的 pull request,那么请基于 feature 分支来做,每隔一段时间我们会合并 feature 到 master,并发布一个包含 new feature 的版本。

Bugs

我们使用 GitHub Issues 来做 bug 追踪。

在你报告一个 bug 之前,请先确保已经搜索过已有的 issue 。

第一次贡献

如果你还不清楚怎么在 GitHub 上提 Pull Request ,可以阅读下面这篇文章来学习:

如何优雅地在 GitHub 上贡献代码

为了能帮助你开始你的第一次尝试,我们用 good first issues 标记了一些比较容易修复的 bug 和小功能。这些 issue 可以很好地作为你的首次尝试。

如果你打算开始处理一个 issue,请先检查一下 issue 下面的留言以确保没有别人正在处理这个 issue。如果当前没有人在处理的话你可以留言告知其他人你将会处理这个 issue,以免别人重复劳动。

如果之前有人留言说会处理这个 issue 但是一两个星期都没有动静,那么你也可以接手处理这个 issue,当然还是需要留言告知其他人。

Pull Request

Picasso 团队会关注所有的 pull request,我们会 review 以及合并你的代码,也有可能要求你做一些修改或者告诉你我们为什么不能接受这样的修改。

开发流程

在你 clone 了 Picasso 的代码并且使用 npm install 安装完依赖后,你还可以运行下面几个常用的命令:

  1. npm start 在本地运行 Picasso 项目。
  2. npm run 构建 Picasso 项目