feat: automatic generate README.md

.github/workflow/generate_readme.yml

@@ -0,0 +1,39 @@
+name: generate_readme
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - 'main'
+
+jobs:
+  generate_readme:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+        with:
+          fetch-depth: 0
+
+      - uses: actions/[email protected]
+
+      - id: version
+        run: node script/update.js
+
+      - name: Git commit
+        id: commit
+        run: |
+          git config --local user.email github-actions[bot]@users.noreply.github.com
+          git config --local user.name github-actions[bot]
+          git config --global core.autocrlf true
+          git config --global core.safecrlf false
+          git status
+          git add .
+          git commit -a -m "doc: update list.json"
+        continue-on-error: true
+
+      - name: Git push
+        if: ${{ steps.commit.outcome == 'success' }}
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.ref }}

.github/workflow/pull_request_check.yml

@@ -0,0 +1,24 @@
+name: pull_request_check
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  check:
+    if: github.repository == 'Adpro-Team/GKD_thirdParty_subscription_list'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+
+      - run: npm ci
+
+      - name: Ensure Files Changed
+        uses: danieljimeneznz/[email protected]
+        with:
+          require-changes-to: |
+            list.json
+          prevent-changes-to: |
+            *.md
+          token: ${{ secret.GITHUB_TOKEN }}

CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# 如何让本项目收录你的订阅
+
+很高兴有更多人搭建了第三方的订阅，丰富GKD社区规则。
+
+需要: 良好的网络（能登录、访问Github）
+
+## 开始
+
+1. Fork 本项目
+
+2. **只**修改其中的list.json，在最外层大括号内的末尾添加形如下方的文字：
+
+```json
+{
+  "name": "订阅名字，与你的订阅文件里的name属性相同",
+  "subUrl": "导入订阅的链接",
+  "repo": "Github仓库名，形如：用户名/仓库名。如果没有，请保持为空字符串", //仅支持Github仓库！
+  "branch": "订阅仓库中的发布分支，若repo字段留空，本字段同样留空"
+}
+```
+然后提交
+
+3. 向本项目发起PR（Pull Request）

README.md

@@ -1,2 +0,0 @@
-# GKD_thirdParty_subscription_list
-The list of third party subscription of GKD

Template.md

@@ -0,0 +1,15 @@
+# @Adpro-Team/GKD_thirdParty_subscription_list
+
+Adpro-Team 整理的GKD第三方订阅列表
+
+如何添加你自己的订阅 -> [CONTRIBUTING.md](./CONTRIBUTING.md)
+
+---
+
+--thirdPartySubList--
+
+---
+
+## 感谢以下第三方维护者
+
+![img](https://contrib.rocks/image?repo=Adpro-Team/GKD_thirdParty_subscription_list)

list.json

@@ -0,0 +1,8 @@
+[
+  {
+    "name": "Adpro的GKD订阅",
+    "subUrl": "https://raw.gitmirror.com/Adpro-Team/GKD_subscription/main/dist/Adpro_gkd.json5",
+    "repo": "Adpro-Team/GKD_subscription",
+    "branch": "main"
+  }
+]