Skip to content

Commit 499a6bb

Browse files
committed
docs: 完善pr规范 优化readme 内容
1 parent 4767af3 commit 499a6bb

File tree

4 files changed

+52
-64
lines changed

4 files changed

+52
-64
lines changed

PR规范.md

Lines changed: 0 additions & 58 deletions
This file was deleted.

readme.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,28 @@
44
> flutter ui 开发者社区 提供各种flutter相关开发教程 与 demo
55
66
## 项目背景
7-
* Google推出Flutter跨平台解决方案,渐渐地受到了开发者们的关注,结合dart使用,能够用一套代码实现开发iOS与Android两套应用,未来还将可以直接编译成桌面应用。
7+
* Google推出Flutter跨平台解决方案,渐渐地受到了开发者们的关注,结合dart使用,能够用一套代码实现开发iOS与Android两套应用,同时也是谷歌的下一代操作系统 Fuchsia 的开发框架,未来还将可以直接编译成桌面应用。
88
* Flutter拥有丰富的组件库,多样化的主题与UI风格,让开发者更简单的上手完成界面交互,从而提高了开发效率。
99
* 此套组件库在几次没有硝烟的研讨中,命名为"Flutter UI",使命为"知识千万点,学习第一条。代码快点敲,bug无数行"。没错,就是这么不押韵。
1010

1111

1212
## 开发者如何参与完善控件
1313
<img src="https://raw.githubusercontent.com/efoxTeam/flutter-ui/test/readme/qq-qrcode.png" width="300" />
14-
<p>QQ交流群</p>
15-
* 欢迎有兴趣的小伙伴参与进来,一同完善组件,同是也可以把相关问题通过issues方式与我们联系 [开发者如何参与完善控件](PR规范.md)
1614

15+
欢迎有兴趣的小伙伴QQ扫描以上二维码参与进来,一同完善组件,
16+
同时也可以把相关问题通过[issues](https://github.com/efoxTeam/flutter-ui/issues)方式与我们联系 [开发者如何参与完善控件](readme/pr.md)
1717

18-
## 环境
18+
19+
20+
## 环境与构建
1921
* 自行完成flutter环境配置
2022
* 通过git clone本项目master分支代码,进入项目
2123
* 切换flutter到master分支,步骤如下(若已切换可跳过)
2224
1. flutter channel master // 选择master分支
2325
2. flutter upgrade // 更新代码
24-
* 运行模拟器或真机
25-
* flutter run运行程序
26+
* 运行模拟器或真机
27+
* flutter run //运行程序
28+
* flutter build apk //生成apk
2629

2730
## app预览
2831

git.md renamed to readme/git.md

File renamed without changes.

readme/pr.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## 开发者如何参与完善控件
2+
> 开发者可以选择完善喜欢翻译的控件文档,或者增加控件Demo示例
3+
4+
* fork 一份自己的仓库
5+
* git clone https://github.com/efoxTeam/flutter-ui 拉取项目到本地
6+
* 打开项目 flutter-ui/lib/config/index.dart,修改里面isPro变量为false,(目的加载本地文件)
7+
### 完善文档
8+
* 完善控件文档的,您可打开flutter-ui/docs/widget/animate/animationcontroller/index.md,构建AnimationController控件的说明文档,该文档包括但不限于(控件介绍,控件构造方法,控件属性介绍)
9+
10+
### 增加控件demo
11+
* 完善控件的,如要完善Animate下的AnimationController控件,打开项目 flutter-ui/lib/widget/animate/animationcontroller/demo.dart,在此文件下构建您的demo运行即可看到效果
12+
13+
### 提交PR
14+
* 最后将您的代码提Pull request到test分支,我们会定期merge发版
15+
16+
## 如何提交PR
17+
* fork项目到自己仓库
18+
* git clone (您的仓库地址)到本地
19+
* 建立上游连接
20+
* git remote add upstream https://github.com/efoxTeam/flutter-ui
21+
* 创建开发分支(非必须)
22+
* git checkout -b test
23+
* 修改提交代码
24+
* git status
25+
* git add .
26+
* git commit -m 'feat: message'
27+
* git push origin test
28+
* 同步代码
29+
* git fetch upstream
30+
* git merge upstream/test
31+
* git push origin test
32+
* 提交PR
33+
* 到自己github仓库对应fork的项目下new pull request
34+
35+
## 提交消息规范
36+
+ feat:新功能(feature)
37+
+ fix:修补bug
38+
+ docs:文档(documentation)
39+
+ style: 格式(不影响代码运行的变动)
40+
+ refactor:重构(即不是新增功能,也不是修改bug的代码变动)
41+
+ test:增加测试
42+
+ chore:构建过程或辅助工具的变动
43+

0 commit comments

Comments
 (0)