docs: fix and optimise compile instruction #4540

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

JackyHe398 wants to merge 2,318 commits into vernesong:dev from JackyHe398:dev

.github/ISSUE_TEMPLATE/bug_report.yml

-Original file line number
+Diff line change
@@ -0,0 +1,153 @@
+    name: Bug报告
+    description: Create a Bug report to help us improve
+    title: "[Bug] "
+    labels: ["bug"]
+    body:
+      - type: checkboxes
+        id: verify_step
+        attributes:
+          label: Verify Steps
+          description: |
+            在提交之前，请确认 / Please verify that you've followed these steps.
+          options:
+            - label: Tracker 我已经在 [Issue Tracker](……/) 中找过我要提出的问题
+              required: true
+            - label: Branch 我知道 OpenClash 的 Dev 分支切换开关位于插件设置-版本更新中，或者我会手动下载并安装 Dev 分支的 OpenClash
+              required: true
+            - label: Latest 我已经**使用最新 Dev 版本**测试过，问题依旧存在
+              required: true
+            - label: Relevant 我知道 OpenClash 与 内核(Core)、控制面板(Dashboard)、在线订阅转换(Subconverter)等项目之间**无直接关系**，仅相互调用
+              required: true
+            - label: Definite 这确实是 OpenClash 出现的问题
+              required: true
+            - label: Contributors 我有能力协助 OpenClash 开发并解决此问题
+              required: false
+            - label: Meaningless 我提交的**是无意义的**催促更新或修复请求
+              required: false
+      - type: input
+        id: openclash_version
+        attributes:
+          label: OpenClash Version
+          description: |
+            OpenClash 版本号
+          placeholder: "v0.0.0-beta"
+        validations:
+          required: true
+      - type: dropdown
+        id: bug_os
+        attributes:
+          label: Bug on Environment
+          description: |
+            发现问题所在的系统环境 / System Environment
+          multiple: true
+          options:
+            - Official OpenWrt
+            - Lean
+            - Immortalwrt
+            - Istoreos
+            - Docker
+            - Other
+        validations:
+          required: true
+      - type: input
+        id: openwrt_version
+        attributes:
+          label: OpenWrt Version
+          description: |
+            Openwrt 固件版本
+          placeholder: "OpenWrt 0.0.0 r0-0"
+        validations:
+          required: true
+      - type: dropdown
+        id: bug_platform
+        attributes:
+          label: Bug on Platform
+          description: |
+            发现问题所在的架构平台 / Platform
+          multiple: true
+          options:
+            - Linux-386
+            - Linux-amd64(x86-64)
+            - Linux-amd64-v3(x86-64)
+            - Linux-armv5
+            - Linux-armv6
+            - Linux-armv7
+            - Linux-arm64
+            - Linux-loong64
+            - Linux-mips-hardfloat
+            - Linux-mips-softfloat
+            - Linux-mips64
+            - Linux-mips64le
+            - Linux-mipsle-hardfloat
+            - Linux-mipsle-softfloat
+            - Linux-riscv64
+            - Other
+            - All
+        validations:
+          required: true
+      - type: textarea
+        id: describe_bug
+        attributes:
+          label: Describe the Bug
+          description: |
+            对 Bug 本身清晰而简洁的描述 / Describe the Bug
+        validations:
+          required: true
+      - type: textarea
+        id: reproduce_bug
+        attributes:
+          label: To Reproduce
+          description: |
+            复现此 Bug 的步骤 / How to reproduce?
+        validations:
+          required: true
+      - type: textarea
+        id: openclash_log
+        attributes:
+          label: OpenClash Log
+          description: |
+            在下方附上 OpenClash 调试日志 / OpenClash Debug Log
+            调试日志在插件设置-调试日志中生成，**并非只有运行日志**，如调试日志过长，可作为附件在最下方上传
+            **隐私提示: 上传此日志前请注意检查、屏蔽公网IP、节点、密码等相关敏感信息**
+          placeholder: "我已知晓缺失日志可能会导致开发者无法了解我的情况并降低本issue的处理优先级"
+          render: log
+        validations:
+          required: true
+      - type: textarea
+        id: openclash_config
+        attributes:
+          label: OpenClash Config
+          description: |
+            在下方附上与 Bug 相关的系统配置、防火墙规则或环境变量 / System config
+            非 Clash Yaml 文件
+            **非必填项**
+          render: shell
+        validations:
+          required: false
+      - type: textarea
+        id: excepted_behavior
+        attributes:
+          label: Expected Behavior
+          description: |
+            对预期修复后情况的清晰明了的描述 / Expected behavior
+        validations:
+          required: true
+      - type: textarea
+        id: additional_context
+        attributes:
+          label: Additional Context
+          description: |
+            在此处添加其它信息或屏幕截图 / Additional Context
+        validations:
+          required: false

.github/ISSUE_TEMPLATE/config.yml

-Original file line number
+Diff line change
@@ -0,0 +1,47 @@
+    blank_issues_enabled: false
+    contact_links:
+      - name: 发表Issue前请先在Issues与Discussions中搜索相关内容
+        url: https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md#在提问之前
+        about: 请有意义且描述明确的描述问题症状而非你的猜测 问题解决后加个简短的补充说明
+      - name: 启动成功后无法访问个别网站 | 启动成功后个别网站不想走代理流量
+        url: https://www.bing.com/search?q=clash+rule+写+教&ensearch=1
+        about: 想要了解clash规则编写相关的问题
+      - name: CLASH CORE | PERIUM CORE & 内核问题 | 节点协议加密方式 | 规则 | 内核功能建议
+        url: https://github.com/Dreamacro/clash/issues/new/choose
+        about: 原版内核 | P核
+      - name: META CORE | MIHOMO CORE & 内核问题 | 节点协议加密方式 | 规则 | 内核功能建议
+        url: https://github.com/MetaCubeX/mihomo/issues/new/choose
+        about: M核
+      - name: 在线订阅转换问题 | 在线订阅转换增加节点协议加密方式 | 在线订阅转换功能建议
+        url: https://github.com/tindy2013/subconverter/issues/new/choose
+        about: 提供并增加预设订阅转换服务地址请通过上方 功能请求 发表
+      - name: DASHBOARD & 控制面板问题 | 面板功能建议
+        url: https://github.com/Dreamacro/clash-dashboard/issues/new/choose
+        about: 面板问题先请尝试 更换近期未使用过面板设备 或 使用浏览器隐私匿名无痕...模式 访问
+      - name: YACD & 控制面板问题 | 面板功能建议
+        url: https://github.com/haishanh/yacd/issues/new/choose
+        about: 面板问题先请尝试 更换近期未使用过面板设备 或 使用浏览器隐私匿名无痕...模式 访问
+      - name: METACUBEXD & 控制面板问题 | 面板功能建议
+        url: https://github.com/MetaCubeX/metacubexd/issues/new/choose
+        about: 面板问题先请尝试 更换近期未使用过面板设备 或 使用浏览器隐私匿名无痕...模式 访问
+      - name: YACD-META & 控制面板问题 | 面板功能建议
+        url: https://github.com/MetaCubeX/Yacd-meta/issues/new/choose
+        about: 面板问题先请尝试 更换近期未使用过面板设备 或 使用浏览器隐私匿名无痕...模式 访问
+      - name: DASHBOARD-META & 控制面板问题 | 面板功能建议
+        url: https://github.com/MetaCubeX/Razord-meta/issues/new/choose
+        about: 面板问题先请尝试 更换近期未使用过面板设备 或 使用浏览器隐私匿名无痕...模式 访问
+      - name: 我想讨论OpenClash的某个功能 | 我不确定是什么问题 | 我的问题不属于上述选项 | 我的问题无法得到原作者原仓库的帮助
+        url: https://github.com/vernesong/OpenClash/discussions/new/choose
+        about: 礼多人不怪 而且有时还很有帮助

.github/ISSUE_TEMPLATE/feature_request.yml

-Original file line number
+Diff line change
@@ -0,0 +1,40 @@
+    name: 功能请求
+    description: Suggest an idea for this project
+    title: "[Feature] "
+    labels: [enhancement]
+    body:
+      - type: checkboxes
+        id: verify_step
+        attributes:
+          label: Verify Steps
+          description: "在提交之前，请确认 / Please verify that you've followed these steps"
+          options:
+            - label: Tracker 我已经在 [Issue Tracker](……/) 中找过我要提出的问题
+              required: true
+            - label: Latest 我已经**使用最新 Dev 版本**查看过，并不包含该功能特性或者还不完善
+              required: true
+            - label: Relevant 我知道 OpenClash 与 内核(Core)、控制面板(Dashboard)、在线订阅转换(Subconverter)等项目之间**无直接关系**，仅相互调用
+              required: true
+            - label: Definite 这确实是 OpenClash 应包含的特性
+              required: true
+            - label: Contributors 我有能力协助 OpenClash 开发或完善此功能特性
+              required: false
+            - label: Meaningless 我提交的**是无意义的**催促更新或修复请求
+              required: false
+      - type: textarea
+        attributes:
+          label: Describe the Feature
+          description: |
+             清晰明了地描述您的想法. 例如你想实现什么 Feature 特性或功能? 如何实现该功能? 目前 OpenClash 的行为是什么?
+        validations:
+          required: true
+      - type: textarea
+        attributes:
+          label: Describe Alternatives
+          description: |
+            对您考虑过的任何替代解决方案或备选功能进行清晰、简洁的描述.
+        validations:
+          required: false

.github/workflows/clear_cache.yml

-Original file line number
+Diff line change
@@ -0,0 +1,41 @@
+    name: Clean jsDelivr Cache
+    on:
+      push:
+        branches:
+          - master
+          - dev
+          - core
+          - package
+        paths-ignore:
+          - 'README.md'
+          - 'LICENSE'
+    jobs:
+      jsDelivr:
+        runs-on: ubuntu-latest
+        steps:
+        - name: Apt Update
+          env:
+            DEBIAN_FRONTEND: noninteractive
+          run: |
+            sudo apt-get update
+            sudo apt-get -y install jq
+        - uses: actions/checkout@v4
+        # https://github.com/marketplace/actions/git-changesets
+        - id: changed_files
+          name: git-changesets
+          uses: collin-miller/git-changesets@v1
+          with:
+              # Default format is 'csv'. Other valid options are 'space-delimited' and 'json'.
+              format: json
+        - name: Clean jsDelivr Cache
+          run: |
+            echo '${{ steps.changed_files.outputs.added_modified }}' | jq -r '.[]' | while read file; do
+                # echo ${{ steps.changed_files.outputs.all }}
+                curl -sL --retry 3 "https://purge.jsdelivr.net/gh/vernesong/OpenClash@${{ github.ref_name }}/${file}"
+            done

.github/workflows/close_issues.yml

-Original file line number
+Diff line change
@@ -0,0 +1,19 @@
+    name: Mark and close stale issues
+    on:
+      schedule:
+        - cron: "30 8 * * *"
+    jobs:
+      stale:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/stale@v5
+            with:
+              stale-issue-message: 'This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 5 days'
+              days-before-stale: 60
+              days-before-close: 5
+              operations-per-run: 200

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: fix and optimise compile instruction #4540

Uh oh!

Diff view

Diff view

Uh oh!

There are no files selected for viewing

Uh oh!

Uh oh!

docs: fix and optimise compile instruction #4540

Are you sure you want to change the base?

Uh oh!

docs: fix and optimise compile instruction #4540

Uh oh!

Diff view

Diff view

Uh oh!

There are no files selected for viewing

Uh oh!