Prechádzať zdrojové kódy

update: 更新字段说明和适配代码测试提示

XingHeYuZhuan 2 týždňov pred
rodič
commit
987917808c
1 zmenil súbory, kde vykonal 4 pridanie a 2 odobranie
  1. 4 2
      README.md

+ 4 - 2
README.md

@@ -20,10 +20,10 @@
 
 | 字段名           | 类型    | 说明                       |
 | --------------- | ------- | -------------------------- |
-| id              | String  | 唯一标识(建议拼音或缩写) |
+| id              | String  | 唯一标识(拼音或缩写,如果可以更建议使用域名<br>一般来说我们建议教务使用全大写 工具使用小写 |
 | name            | String  | 中文名称                   |
 | initial         | String  | 名称首字母(用于排序)     |
-| resource_folder | String  | 资源文件夹名称             |
+| resource_folder | String  | 资源文件夹名称 (建议和id保持一致)|
 
 示例:
 ```yaml
@@ -93,6 +93,8 @@ adapters: #固定字段
       - 所有开发者需先 fork 本仓库(本仓库带有 `lighthouse` 标签,已经在开发者软件版本关闭检查逻辑,希望各位开发者对使用的git仓库链接负责)。
 
 3.  **添加适配代码**
+      >在**不更新索引**的情况下,修改任何yaml文件是没有作用的(任何对于yaml文件的修改都需要编译索引才能应用),所以我们才提供了asset_js_path: "test.js" 占位用于在不更新索引的情况下测试适配代码
+
       fork仓库之后 建议测试代码不要在自己的主分支测试哦,可以在仓库在开一个测试分支,测试完成可以一次将正确的代码提交到主分支,这样你的提交历史就不会充斥错误的提交历史  
       **注意** 仓库更改数据结构,我们的索引需要编译,软件只接收编译过的索引文件,如果你要测试适配代码,我建议你在`resources\GLOBAL_TOOLS\test.js`文件放置适配代码,我们定义这个位置是一个适配占位符,开发者版本添加了网址链接输入,希望了解适配流程,**注意提交pr请不要把测试的test.js也发上去哦!!**  
       ```yaml