diff --git a/docs/contribute.md b/docs/contribute.md new file mode 100644 index 00000000..a9c269ab --- /dev/null +++ b/docs/contribute.md @@ -0,0 +1,35 @@ +# Flutter Go 共建 + +# 共建说明 + +由于 **Flutter 版本迭代速度较快**,产生的内容较多, 而我们**人力有限**无法更加全面快速的支持Flutter Go的日常维护迭代, 如果您对flutter go的共建感兴趣, 欢迎您来参与本项目的共建. + +**凡是参与共建的成员. 我们会将您的头像与github个人地址收纳进我们的官方网站中.** + +# 共建方式 + +1. 共建组件 + - 本次更新, 开放了 **Widget 内容收录** 的功能, 您需要通过 [goCli](https://github.com/alibaba/flutter-go/blob/master/docs/go-cli.md)工具, 创建标准化组件,编写markdown代码。 + + - 为了更好记录您的改动目的, 内容信息, 交流过程, 每一条PR都需要对应一条 **Issue**, 提交你发现的`BUG`或者想增加的`新功能`, 或者想要增加新的[共建组件](https://github.com/alibaba/flutter-go/blob/maseter/docs/widget.md), + + - 首先选择你的`issue`在类型,然后通过 **Pull Request** 的形式将文章内容, api描述, 组件使用方法等加入进我们的Widget界面。 + + ![](https://img.alicdn.com/tfs/TB1r3LEbKL2gK0jSZFmXXc7iXXa-858-317.png) + +2. 提交文章和修改bug + - 您也可以将例如**日常bug.** **未来feature**等的功能性PR, 申请提交到我们的的主仓库。 + + +# 参与共建 + +关于如何提PR请先阅读以下文档 + +- [如何向仓库提交 Pull Request](https://github.com/alibaba/flutter-go/blob/master/docs/push-pr.md) +- [dart 代码规范](https://github.com/alibaba/flutter-go/blob/master/Flutter_Go%20%E4%BB%A3%E7%A0%81%E5%BC%80%E5%8F%91%E8%A7%84%E8%8C%83.md) +- [如何使用go-cli 创建 Widget Page](https://github.com/alibaba/flutter-go/blob/master/docs/widget.md) + + +# 贡献指南 + +此项目遵循[贡献者行为准则](https://github.com/spring-projects/spring-framework/blob/master/CODE_OF_CONDUCT.adoc)。参与此项目即表示您同意遵守其条款.