mirror of
https://github.com/alibaba/flutter-go.git
synced 2025-08-06 09:01:00 +08:00
docs(add widget about issue):
This commit is contained in:
20
.github/ISSUE_TEMPLATE/widget about.md
vendored
Normal file
20
.github/ISSUE_TEMPLATE/widget about.md
vendored
Normal file
@ -0,0 +1,20 @@
|
||||
---
|
||||
name: "📄 Widget About"
|
||||
about: something about widget
|
||||
---
|
||||
|
||||
## Widget About
|
||||
|
||||
**仅限中文与英文**, 其他语言的提交将直接被关闭
|
||||
|
||||
请先确认查找了已有的 issue [GitHub issues](https://github.com/apache/incubator-shardingsphere-example/issues).
|
||||
|
||||
为了更好的收录您反馈或者提交的相关pr. 请您关注您提交的问题, 我们可能需要更多的详细信息, 我们会在issue下先您收集相关信息,
|
||||
如果长时间未得到您的回复, 如果我们无法在某些环境上重现该问题, 并且您**超过7天未回复**, 我们可能会关 **闭掉issue**, 谢谢
|
||||
|
||||
|
||||
## 描述widget 类型
|
||||
|
||||
## widget 简要描述
|
||||
|
||||
##
|
@ -5,9 +5,16 @@
|
||||
此项目遵循[贡献者行为准则](https://github.com/spring-projects/spring-framework/blob/master/CODE_OF_CONDUCT.adoc)。参与此项目即表示您同意遵守其条款.
|
||||
|
||||
|
||||
# 如何提PR
|
||||
如何提PR请先阅读以下文档
|
||||
- [如何提PR](https://github.com/alibaba/flutter-go/blob/master/docs/push-pr.md)
|
||||
- [如何使用go-cli](https://github.com/alibaba/flutter-go/blob/master/docs/go-cli.md);
|
||||
- [dart 代码规范](https://github.com/alibaba/flutter-go/blob/beta/Flutter_Go%20%E4%BB%A3%E7%A0%81%E5%BC%80%E5%8F%91%E8%A7%84%E8%8C%83.md)
|
||||
|
||||
PR的第一步就是提交issue,即提交你发现的BUG:
|
||||
|
||||
# Issue
|
||||
PR的第一步就是提交issue,即提交你发现的BUG 或者 想加入的功能, 选择你issue在类型
|
||||
|
||||

|
||||
|
||||
|
||||
您的 Pull Request 可能包含以下几种
|
||||
|
109
docs/go-cli.md
Normal file
109
docs/go-cli.md
Normal file
@ -0,0 +1,109 @@
|
||||
# GoCli 使用方式
|
||||
|
||||
## 安装
|
||||
|
||||
获取最新flutterGo代码分之后. 在源文件下会有 **go-cli** 的文件.
|
||||
|
||||
首先进入该文件夹并安装go-cli所需要的依赖
|
||||
|
||||
```
|
||||
cd go-cli
|
||||
pub get
|
||||
```
|
||||
|
||||
然后使用pub global命令将文件包注册到全局
|
||||
|
||||
```
|
||||
pub global activate --source path /{your flutter go absolute path}/fluttergo/go-cli
|
||||
|
||||
```
|
||||
|
||||
使用pub global list命令查看全局包列表 如果看到有 **goCli 1.0.0**则证明安装成功
|
||||
|
||||
```
|
||||
goCli 1.0.0 at path "/{youpath}/flutter-go/go-cli"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 使用方式
|
||||
|
||||
现在支持以下几种命令
|
||||
|
||||
- createDemo 新增flutter go demo.
|
||||
- createPage 新增flutter go page.
|
||||
- watch 动态生成文档与demo相关
|
||||
|
||||
### createDemo
|
||||
|
||||
动态生成widget demo, 可以创建demo.以便详情页中使用
|
||||
|
||||
|
||||
在flutter go 根文件下通过命令行输入以上命令可以进行以下操作
|
||||
|
||||
[✓] 请输入新增加的demo名称? demoName
|
||||
|
||||
[✓] 请输入您的姓名(使用英文) yourName
|
||||
|
||||
[✓] 请输入您的github的email地址 yourEmail
|
||||
|
||||
[✓] 请输入您demo的描述 这是一个测试的标准demo
|
||||
|
||||
|
||||
在完成以上操作后, 可以得到这样的输出:
|
||||
|
||||
|
||||
```
|
||||
------------------
|
||||
您新增的组件信息如下
|
||||
==================
|
||||
{
|
||||
name : demoName
|
||||
author : yourName
|
||||
email : yourEmail
|
||||
desc : 这是一个测试的标准demo
|
||||
}
|
||||
==================
|
||||
[✓] Is this the config you want ? (Y/n) y
|
||||
{
|
||||
新建的demo文件位于 : /flutter go/lib/page_demo_package/demoName_yourName_1a29aa8e_32ae_4241_9c8a_5c9e1f92b096
|
||||
demoId为 : 1a29aa8e_32ae_4241_9c8a_5c9e1f92b096
|
||||
markdown中调用方式 : [demo:1a29aa8e_32ae_4241_9c8a_5c9e1f92b096]
|
||||
}
|
||||
|
||||
```
|
||||
您可以在任意详情页中, 通过以下方式调用
|
||||
|
||||
```
|
||||
[demo: 1a29aa8e_32ae_4241_9c8a_5c9e1f92b096]
|
||||
```
|
||||
|
||||
|
||||
|
||||
### createPage
|
||||
|
||||
使用方式同上. 通过该命令可以创建标准的详情页.您可以通过修改index.md进行动态的更新您所创建的详情页.
|
||||
|
||||
目录结构为
|
||||
|
||||
```
|
||||
standard_pages/
|
||||
├── index.dart (不可人为修改)
|
||||
└── standard_sanfan_ee4feb8e_32ae_4241_9c8a_5c9e1f92b096
|
||||
├── .page.json (不可人为修改)
|
||||
├── index.dart (不可人为修改)
|
||||
└── index.md (可修改)
|
||||
```
|
||||
|
||||
### watch
|
||||
|
||||
监听并编译standard_pages与page_demo_package下的的文件改动. 动态处理demo目录与文件markdown转化等.
|
||||
|
||||
## 注意
|
||||
|
||||
- 在修改page_demo_package或者standard_pages目录下的文件操作时. 建议在flutterGo目录执行goCLi watch 开启文件动态编译
|
||||
- name, author 字段必须使用英文开头, 不允许使用特殊符号. 正常的示范 name ='name_test' author = 'abcdefg';
|
||||
- 暂时阶段demo与page,一经过创建不允许修改名称作者等信息. 凡是被收录进主分支的不允许被删除
|
||||
|
||||
|
Reference in New Issue
Block a user