search

ACG-Q / qd-templates

基于开源新版 QD 框架站发布的公共har模板库
1 stars 0 forks source link

readme

公共模板库 For QD 框架

GitHub last commit

🏠简介

项目基于开源的 QD 框架, 用于指导用户学习如何使用 QD 框架. 项目中的模板均为开源模板, 仅供学习参考使用, 请勿用于商业用途.

点击查看: 模板列表

😀使用 Issue 发布模板

不再建议自行通过 Push 或 PR 的方式发布或更新模板, 请通过 Issue 的方式发布或更新模板, 以便于模板审核及自动化管理.

发布模板流程

  1. 进入 Issue 界面
  2. 点击右上角 New issue 按钮, 选择 HAR 模板发布 对应的 Get Started 按钮
  3. 标题填写 "模板名称 评论区",内容按照要求的格式进行填写
  4. 点击 Submit new issue 按钮
  5. 等待 Github Actions 运行完成, 会自动进行 PR
  6. 等待模板审核通过, 仓库拥有者会进行合并
  7. 合并完成后, 即完成模板的发布

Tips:

  1. 请勿在 Issue 里发布其他内容, 否则会被关闭.

  2. 自动化 更新 模板: 直接在 Issue 里编辑内容, 不要重新发布 Issue.

    PS:

    Issue 内容须符合下述模板格式, 请确保 Issue 包含 har 标签;

    非 Issue 作者更新, 请在评论区提交 har 模板内容并 @Issue作者或仓库管理员.

  3. 自动化 删除 无效模板: 直接将对应的 Issue 标签标记为 invalid 即可.

    PS: Issue 内容须符合下述模板格式.

  4. 仓库管理员对 PR 进行 Merge 时推荐使用 Squash Merge 方式.

Q&A: 旧的 HAR 模板如何更新?

  1. 复制以下格式内容至 HAR 模板所对应的 Issue 评论区内主楼部分, 编辑并修改其中的内容:

    ### HAR 模板名称

请将此行替换为**模板名称** ( HAR 文件的命名, 空格请用下划线代替, 允许中文, 请勿使用括号等特殊字符)

### 作者信息

请将此行替换为**作者信息** ( HAR 文件的作者名或昵称, 用英文逗号 `,` 分隔多个作者, 请勿使用括号等特殊字符)

### 模板备注及说明

请在此输入模板备注及说明 ( HAR 文件的备注及说明, 直接换行即可, 无需<br>)

### HAR 文件名

请将此行替换为 **HAR 文件名** ( HAR 文件的文件名, 含 `.har` 后缀, 允许中文, 请勿使用括号等特殊字符)

### 其他信息

请在此输入Issue的其他信息, 选填, 如无请填暂无 ( 例如: 对于 Issue 的其他说明 )

### HAR 模板内容

```JSON
请将此行替换为 **HAR 模板内容** (请粘贴 HAR 文件内容, 允许使用 json 格式化工具进行格式化后再粘贴)
```

  2. 修改完成后, 请为 Issue 添加 har 标签, 并点击 Submit changes 按钮进行提交

📄如何注册第三方库

20211021版本已经开放注册第三方库的功能，默认提供 https://github.com/qd-today/templates 仓库，如果需要自建第三方库，请注意一下几点：

  1. 仓库根目录必须要有 tpls_history.json 文件, 需符合以下规范:

    {
    "version":"版本号 yyyymmdd",
    "har": {
        "必填，和name保持一致，注意要在文件里保持唯一": {
            "name": "必填",
            "author": "选填，作者",
            "url": "选填，har链接",
            "update": false,
            "comments": "选填，har文件的注释，可用来解释har所需变量的说明",
            "filename": "必填，content为空时通过此来读取har",
            "content": "选填,不填则根据 filename 的值来读取对应的har文件,默认为base64编码",
            "date": "必填， 日期",
            "version":"必填， 版本号 yyyymmdd，框架通过版本号来判断是否更新模板",
            "commenturl":"选填，模板对应的评论区，留空时不显示按钮"
        }
    }
}

  2. 加速默认是 jsdelivr 加速, 可通过 config 或环境变量配置修改为 ghproxy 或 fastgit 加速, 只支持 Github 仓库的加速

  3. 模板更新规则: 上一次更新的24小时以后更新, 通过 name 判断是否存在, 如果不存在直接新增, 如果存在则通过 version 判断, 版本号大于当前缓存版本则更新

项目不对任何第三方库的内容负责, 请自行判断是否可信

💬FAQ