|
|
@@ -28,14 +28,15 @@
|
|
|
示例：
|
|
|
```yaml
|
|
|
schools: #固定字段
|
|
|
- - id: "GLOBAL_TOOLS"
|
|
|
- name: "通用工具与服务"
|
|
|
- initial: "G"
|
|
|
- resource_folder: "GLOBAL_TOOLS"
|
|
|
- - id: "CUST"
|
|
|
- name: "长春理工大学"
|
|
|
- initial: "C"
|
|
|
- resource_folder: "CUST"
|
|
|
+ - id: "GLOBAL_TOOLS"
|
|
|
+ name: "通用工具与服务"
|
|
|
+ initial: "G"
|
|
|
+ resource_folder: "GLOBAL_TOOLS"
|
|
|
+
|
|
|
+ - id: "CUST"
|
|
|
+ name: "长春理工大学"
|
|
|
+ initial: "C"
|
|
|
+ resource_folder: "CUST"
|
|
|
```
|
|
|
|
|
|
### 适配注意
|
|
|
@@ -71,13 +72,13 @@ schools: #固定字段
|
|
|
示例：
|
|
|
```yaml
|
|
|
adapters: #固定字段
|
|
|
- - adapter_id: "GENERAL_TOOL_01" # id加上序号
|
|
|
- adapter_name: "组件测试"
|
|
|
- category: "GENERAL_TOOL"
|
|
|
- asset_js_path: "school.js" #相对路径
|
|
|
- import_url: ""
|
|
|
- maintainer: "星河欲转"
|
|
|
- description: "这是一个空网站，用于组件测试与演示模式"
|
|
|
+ - adapter_id: "GENERAL_TOOL_01" # id加上序号
|
|
|
+ adapter_name: "组件测试"
|
|
|
+ category: "GENERAL_TOOL"
|
|
|
+ asset_js_path: "school.js" #相对路径
|
|
|
+ import_url: ""
|
|
|
+ maintainer: "星河欲转"
|
|
|
+ description: "这是一个空网站，用于组件测试与演示模式"
|
|
|
```
|
|
|
|
|
|
**注意：**
|
|
|
@@ -88,33 +89,32 @@ adapters: #固定字段
|
|
|
|
|
|
## 开发流程
|
|
|
|
|
|
-1. **Fork 仓库**
|
|
|
+1.**Fork 仓库**
|
|
|
+- 所有开发者需先 fork 本仓库（本仓库带有 `lighthouse` 标签，已经在开发者软件版本关闭检查逻辑，希望各位开发者对使用的git仓库链接负责）。
|
|
|
|
|
|
- - 所有开发者需先 fork 本仓库（本仓库带有 `lighthouse` 标签，已经在开发者软件版本关闭检查逻辑，希望各位开发者对使用的git仓库链接负责）。
|
|
|
+2.**添加适配代码**
|
|
|
+>在**不更新索引**的情况下，修改任何yaml文件是没有作用的（任何对于yaml文件的修改都需要编译索引才能应用），所以我们才提供了asset_js_path: "test.js" 占位用于在不更新索引的情况下测试适配代码
|
|
|
|
|
|
-3. **添加适配代码**
|
|
|
- >在**不更新索引**的情况下，修改任何yaml文件是没有作用的（任何对于yaml文件的修改都需要编译索引才能应用），所以我们才提供了asset_js_path: "test.js" 占位用于在不更新索引的情况下测试适配代码
|
|
|
-
|
|
|
- fork仓库之后 建议测试代码不要在自己的主分支测试哦,可以在仓库在开一个测试分支,测试完成可以一次将正确的代码提交到主分支,这样你的提交历史就不会充斥错误的提交历史
|
|
|
- **注意** 仓库更改数据结构,我们的索引需要编译,软件只接收编译过的索引文件,如果你要测试适配代码,我建议你在`resources\GLOBAL_TOOLS\test.js`文件放置适配代码,我们定义这个位置是一个适配占位符,开发者版本添加了网址链接输入,希望了解适配流程,**注意提交pr请不要把测试的test.js也发上去哦！！**
|
|
|
- ```yaml
|
|
|
- - adapter_id: "GENERAL_TOOL_02"
|
|
|
- adapter_name: "适配代码测试"
|
|
|
- category: "GENERAL_TOOL"
|
|
|
- asset_js_path: "test.js"
|
|
|
- import_url: ""
|
|
|
- maintainer: "星河欲转"
|
|
|
- description: "空网站以及不存在适配代码,用于在不更新索引的情况下给开发者进行适配的软件测试"
|
|
|
- ```
|
|
|
- #### 如果要更新索引也可以自行了解仓库的ci配置 (我不建议测试适配,还要更新索引)
|
|
|
+fork仓库之后 建议测试代码不要在自己的主分支测试哦,可以在仓库在开一个测试分支,测试完成可以一次将正确的代码提交到主分支,这样你的提交历史就不会充斥错误的提交历史
|
|
|
+**注意** 仓库更改数据结构,我们的索引需要编译,软件只接收编译过的索引文件,如果你要测试适配代码,我建议你在`resources\GLOBAL_TOOLS\test.js`文件放置适配代码,我们定义这个位置是一个适配占位符,开发者版本添加了网址链接输入,希望了解适配流程,**注意提交pr请不要把测试的test.js也发上去哦！！**
|
|
|
+```yaml
|
|
|
+- adapter_id: "GENERAL_TOOL_02"
|
|
|
+ adapter_name: "适配代码测试"
|
|
|
+ category: "GENERAL_TOOL"
|
|
|
+ asset_js_path: "test.js"
|
|
|
+ import_url: ""
|
|
|
+ maintainer: "星河欲转"
|
|
|
+ description: "空网站以及不存在适配代码,用于在不更新索引的情况下给开发者进行适配的软件测试"
|
|
|
+```
|
|
|
+#### 如果要更新索引也可以自行了解仓库的ci配置 (我不建议测试适配,还要更新索引)
|
|
|
|
|
|
-4. **软件测试**
|
|
|
+3.**软件测试**
|
|
|
|
|
|
- - 开发者需要安装 dev(开发者版，图标红色)版本app,在软件的“我的-更多-更新仓库”中选择**自定义仓库或私有仓库**，来拉取并更新自己的仓库代码进行实际测试，完成 Beta 阶段适配验证。
|
|
|
+- 开发者需要安装 dev(开发者版，图标红色)版本app,在软件的“我的-更多-更新仓库”中选择**自定义仓库或私有仓库**，来拉取并更新自己的仓库代码进行实际测试，完成 Beta 阶段适配验证。
|
|
|
|
|
|
-5. **提交 PR**
|
|
|
+4.**提交 PR**
|
|
|
|
|
|
- - 测试通过后，提交 Pull Request，等待审核合并。
|
|
|
+- 测试通过后，提交 Pull Request，等待审核合并。
|
|
|
|
|
|
## 社区公约
|
|
|
|
星河欲转