Skip to content

Latest commit

 

History

History
37 lines (19 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

37 lines (19 loc) · 1.61 KB

贡献指南

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

行为准则

我们有一份行为准则,希望所有的贡献者都能遵守。那就是:请保持 md 文档格式清晰,问题用标题三 划分好层次。

建议使用 VSCODE 进行开发,并且要求安装prettier插件, 在 user settings 设置"editor.formatOnSave": true 来保持代码格式一致。

透明的流程

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

分支管理

目前手册正在生成中,还不是很完善,之维护 master 分支,后期将提供一个 feature 分支来提交新知识点。

Bugs

我们使用 GitHub Issues 来做 bug 追踪。 如果你想要你发现的 bug 被快速解决,最好的办法就是通过 GitHub Issues 准确的描述 bug。

这里我们指的 bugs 是文章文字错误,或者内容错误。

第一次贡献

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

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

Pull Request

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

最后

愿我们的社区越来越美好!