/开发指南

参与开发

这篇指南会指导你如何为 Apron Design 贡献一份力量。请在提 issue 或者 pr 之前阅读这份指南,大概只需要花几分钟时间。

行为准则

我们有一份行为准则,希望所有贡献者都能遵守。

请花一点时间阅读一遍全文,以确保你明白哪些是可以做的,哪些不可以。

代码规范

我们的代码要严格按照代码规范的要求。除了遵循 eslint standard 以外,还有一些其他的要求。参见代码规范

透明的开发

所有的工作都会放在 Github 上。

不管是核心成员还是外部贡献者的 pull request 都需要通过代码审查(code review)。

分支管理

目前我们拥有以下固定的分支:

  • dev
  • main

我们使用 dev 分支进行维护类型的开发。

每当有新组件加入,我们会新建分支,并且以 merge request 合并进 main 分支进行管理,所以如果你有全新的组件加入,请以 main 分支作为最新版本。

我们会不定期根据实际情况进行版本的更新。请留意 更新日志

Bugs

我们使用 Github Issues 来做 bug 追踪。如果你想要你发现的 bug 被快速解决,最好的方式就是通过 issue 向我们提交。

在你报告一个 bug 之前,请先确保已经搜索过已有 issue 和阅读了常见问题

新增功能

如果你有改进我们的 API 或者新增功能的想法,我们同样推荐你使用 issue 来告诉我们。

首次贡献

如果你还不清楚怎么在 Github 上提 Pull Request,可以阅读这篇文章来了解:

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