Tag 相关标准完善 (#33)

* new branch for process * Update document/Tag.md Co-authored-by: 澄沨 <[email protected]> * Update README.md Co-authored-by: 澄沨 <[email protected]> * Update README.md Co-authored-by: 林林 <[email protected]> * Update README.md and close [Bug]README坏链 #22 * Update README.md Co-authored-by: 林林 <[email protected]> * Update README.md Co-authored-by: 林林 <[email protected]> * Sync main to process (#42) * Issue Tamplate 重构 (#40) * Issue Tamplate 重构 * refactor: update issue template * refactor: update issue template * refactor: refactor issue template (#41) * Issue Tamplate 重构 * refactor: update issue template * refactor: update issue template * update issue templates * Update Tag.md * Refactor blog navigation documents close [RFC-1]现有标签合并·存废讨论 #27 and close [RFC-2]补充部分警示Tag #28 * perf: Modified some details * refactor: refactor blog navigation documents close #27 and #28 * perf: Modified some details * refactor: Refactor blog navigation documents and update README.md --------- Co-authored-by: 澄沨 <[email protected]> Co-authored-by: 林林 <[email protected]>
zh-blogs · Jul 6, 2024 · b053264 · b053264
1 parent 1c8b4a6
commit b053264
Show file tree

Hide file tree

Showing 12 changed files with 275 additions and 186 deletions.
diff --git a/.github/ISSUE_TEMPLATE/06-Project Proposal.yml b/.github/ISSUE_TEMPLATE/06-Project Proposal.yml
@@ -15,8 +15,8 @@ body:
         ## zhblogs Project Proposal 模板
         ---
         ***请按照已给出的标题格式替换并补充 <> 内部的信息***
-        非常感谢您给本项目提出的建议，我们会认真对待每一条建议，如果您的建议被采纳，我们会在项目中标注您的贡献。
-        请按照下面的模板填写，方便我们更快的了解您对本项目提出的建议。
+        衷心感谢您为本项目提出的宝贵建议，我们将认真评估每一条建议。若您的建议被采纳，我们会在项目中标注您的贡献。
+        请按照以下模板填写您的建议，以便我们快速且全面地了解您的想法。
   - type: dropdown
     id: proposal_direction
     attributes:

diff --git a/.github/ISSUE_TEMPLATE/07-Join Us.yml b/.github/ISSUE_TEMPLATE/07-Join Us.yml
@@ -15,8 +15,8 @@ body:
         ## zhblogs Join Us 模板
         ---
         ***请按照已给出的标题格式替换并补充 <> 内部的信息***
-        非常感谢您能够加入本项目组，为本项目的发展提供帮助。
-        请按照下面的模板填写，方便我们了解您的加入申请
+        非常感谢您有意加入我们的项目组，并愿意为本项目贡献您的力量。
+        请您按照提供的模板填写申请信息，这将有助于我们更全面地了解您的背景与申请。
   - type: input
     id: github_id
     attributes:

diff --git a/.github/ISSUE_TEMPLATE/08-Cooperation Application.yml b/.github/ISSUE_TEMPLATE/08-Cooperation Application.yml
@@ -15,7 +15,7 @@ body:
         ## zhblogs Cooperation Application 模板
         ---
         ***请按照已给出的标题格式替换并补充 <> 内部的信息***
-        感谢您对本项目的支持，我们非常欢迎您的合作申请。
+        感谢您对本项目的支持，我们非常欢迎您提交合作申请。
         请按照下面的模板填写，方便我们了解您的合作申请。
   - type: input
     id: organization_name

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,73 @@
+# 参与贡献
+
+## 标准贡献
+
+0. 提交 Issue
+
+    对于任何疑问或新标准的提议，我们建议您首先提交一个 Issue 以便我们共同讨论。在提交 Issue 时，您可以按照以下步骤操作，并在相应的 Issue 中附上链接，以便我们更全面地理解和评估您的想法。
+
+1. Fork 并 close 仓库至本地
+
+    ```bash
+    git clone [email protected]:YOUR_GITHUB_USERNAME/blog-daohang.git
+    ```
+
+2. 为新标准或 Issue 创建一个语义化分支
+
+    ```bash
+    git checkout -b your-meaningful-branch-name
+    ```
+
+3. 文档编写
+
+    编写过程中，请遵守[文档编写规范](./DOCUMENTATIONSTYLE.md)
+
+    建议使用 [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) VScode 插件对 Markdown 文档语法进行检查和文档预览，确保无 Markdown 语法警告。
+
+    > 可以依照需求对 HTML 标签进行放行，建议尽可能少的使用 HTML 标签，如有特殊排版需要，请确保遵守语义化标准的情况下使用对应标签
+
+4. 发布分支
+
+    ```bash
+    git push origin your-meaningful-branch-name
+    ```
+
+5. 切换分支并提交 Pull Request
+
+    由于本仓库并非代码仓库，因此我们参考了：[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) 规范，并在此基础上我们定义了适用于本项目标准文档的 pr 规范，详见：[Pull Request 规范](#pull-request-commit-规范)，请您在提交 pr 时遵守此规范。
+
+## Pull Request (Commit) 规范
+
+### 提交规范
+
+提交 pr/commit 的标题格式为 `<type>[<scope>]: <subject>`
+
+- type 用于说明修改类型，填写内容参见下文
+- scope 用于说明 pr/commit 影响的范围，填写内容参见下文
+- subject 是 pr/commit 目的的简短描述，语言不限，结尾不加任何标点符号
+
+> 如果您的文档尚未完成，请点击 Draft Pull Request，而不是 Open Pull Request
+
+### 修改类型说明
+
+- feat：新建标准大项——新文档（feature）
+- fix：修复文档漏洞，对部分文档说明进行修改
+- add: 新增标准子项——在已有文档基础上新增子项目说明
+- style：对样式进行优化（不影响文档表意的变动）
+- refactor：重构（不影响文档表意的情况下对文档进行重新编写）
+- perf：优化文档，例如：文档表意不明确的地方进行进一步说明等
+- revert：回滚到上一个版本
+- merge：合并
+- sync：同步变动
+
+### 影响范围说明
+
+- feat：标准大项名称
+- fix：修改的文档名称（无需携带文件名后缀）
+- add: 新增标准子项——在已有文档基础上新增子项目说明
+- style：规范（不影响文档表意的变动）
+- refactor：重构（不影响文档表意的情况下对文档进行重新编写）
+- perf：优化文档，例如：文档表意不明确的地方进行进一步说明等
+- revert：回滚到上一个版本
+- merge：合并
+- sync：同步变动
diff --git a/README.md b/README.md
@@ -1,85 +1,114 @@
-## 中文博客列表导航项目
+# 中文博客列表导航项目
 
-<img align="right" src="https://avatars.githubusercontent.com/u/102334874" alt="logo" height="128px"/>
+<div align="center">
+<img src="https://img.shields.io/github/stars/zh-blogs/blog-daohang?style=for-the-badge" referrerpolicy="no-referrer" alt="stars">&nbsp;&nbsp;&nbsp;&nbsp;
+<img src="https://img.shields.io/badge/%E7%9B%AE%E5%89%8D%E7%89%88%E6%9C%AC-V2-reen?style=for-the-badge" referrerpolicy="no-referrer" alt="stars">&nbsp;&nbsp;&nbsp;&nbsp;
+<img src="https://img.shields.io/badge/%E5%BC%80%E5%8F%91%E4%B8%AD-V3-orange?style=for-the-badge" referrerpolicy="no-referrer" alt="stars">
+</div>
 
-<img src="https://img.shields.io/github/stars/zh-blogs/blog-daohang?style=for-the-badge" referrerpolicy="no-referrer" alt="stars">  <img src="https://img.shields.io/badge/%E7%9B%AE%E5%89%8D%E7%89%88%E6%9C%AC-V2-reen?style=for-the-badge" referrerpolicy="no-referrer" alt="stars">  <img src="https://img.shields.io/badge/%E5%BC%80%E5%8F%91%E4%B8%AD-V3-orange?style=for-the-badge" referrerpolicy="no-referrer" alt="stars">
-
-目前我们依旧在维护 [ V2 版本](https://github.com/zh-blogs/v2) 的项目程序，V3 版本的项目程序正在计划开发中，诚挚邀请对项目感兴趣的您参与 V3 版本的开发当中
-
-[中文博客列表导航V3版本前端](https://github.com/zh-blogs/frontend)
+---
 
-[中文博客列表导航V3版本后端](https://github.com/zh-blogs/backend) 
+<table>
+<td>
+ <img align="right" src="./assets/logo.png" alt="logo" width="300px"/>
+</td>
+<td>
+ <h4>
+        <p>
+        目前我们依旧在维护 <a href="https://github.com/zh-blogs/v2">V2 版本</a> 的项目程序，V3 版本的项目程序正在积极开发中，项目所涉及的审核标准和相关流程也在逐渐完善中。<br/><br/>
+        诚挚邀请对项目感兴趣的您参与到本项目的建设当中来，您可以选择<b>参与开发</b>和<b>参与维护</b>的任意一项，通过本项目的 Issue 联系我们。<br/><br/>
+        当然，如果您对本项目有更好的建议或者意见，也欢迎您通过 Issue 向我们反馈，我们会慎重考虑您的意见和意见。<br/><br/>
+        <a href="https://github.com/zh-blogs/frontend">中文博客列表导航 V3 版本前端</a>  |  <a href="https://github.com/zh-blogs/backend">中文博客列表导航V3版本后端</a>  |  <a href="https://github.com/zh-blogs/blog-daohang/issues/new/choose">联系我们</a>
+        </p>
+    </h4>
+</td>
+</table>
 
 ---
 
-此项目尝试链接全部中文独立博客，目前含有如下功能：
+## 功能列表
+
+本项目尝试链接全部中文独立博客，目前含有如下功能：
 
 1. **查看随机推荐的博客**。
 2. **随机前往已收录的博客**，您可以通过在 URL 添加参数进行指定类型博客的随机跳转，如：[https://zhblogs.ohyee.cc/go?tags=生活](https://zhblogs.ohyee.cc/go?tags=生活)，即可随机访问生活类博客。
-3. 查看本项目**收录博客的部分数据统计**（如：**博客架构统计**、**域名统计**等）。
+3. 查看本项目 **收录博客的部分数据统计** （如：**博客架构统计**、**域名统计** 等）。
 
-本项目会依照**标签标准对博客进行分类**，您可以访问[中文博客列表导航](https://zhblogs.ohyee.cc/)浏览收录的博客列表，并且可以通过标签系统对您感兴趣的博客进行筛选。    
+## 博客收录
 
-如果您喜欢本项目，不妨通过以下方式支持该项目：
+目前，我们通过以下三种方式对博客进行收录：
 
-1. 您可以在项目中搜索您的博客，若未收录，您可以在 issue 中找到申请添加的链接，若已收录，您可以在 issue 中找到信息完善的选项，帮助我们完善您博客的相关信息。
-2. 您可以为本仓库点一个 Star。
-3. 您可以为本项目做宣传，让更多博主知道本项目。
-4. 您可以加入本项目的技术组或者列表维护组，对本项目进行维护。
+1. 通过一些博客集合（上游库）发现并收录。
+2. 参考已收录博客的友情链接进行收录。
+3. 博主的自主提交。
 
-**若您有博客申请收录、博客信息修改、博客失效反馈、博客信息完善、项目 BUG 反馈、项目功能建议、项目合作申请、项目加入申请等内容需要与项目组进行反馈，您可以前往 [Issues · zh-blogs/blog-daohang](https://github.com/zh-blogs/blog-daohang/issues) 选择对应的模板进行反馈**
+我们会依据 [项目相关标准](#项目相关标准) 对博客进行 **博客收录**、**信息完善**、**博客分类** 等相关操作，如您发现项目中您博客的信息、分类等内容有误，或者在浏览过程中发现其它博客的信息有误，也欢迎您通过 Issue 提出修改意见，我们会尽快处理。
 
-### 博客收录
+## 项目相关标准
 
-目前，我们通过以下三种方式对博客进行收录：
+我们对项目实行的相关标准和流程（下称 **文档**）放置在当前项目仓库的 [WIKI](https://github.com/zh-blogs/blog-daohang/wiki) 选项卡中，您可以点击链接前往阅读。
+
+以下是文档的简要目录和说明：
 
-1. 通过一些博客集合（上游库）发现并收录
-2. 根据已收录博客的友情链接或者其它页面对更多的博客进行发现和收录
-3. 博主的自主提交
+|                    标准名称                     |                          标准说明                          |
+| :---------------------------------------------: | :--------------------------------------------------------: |
+|  [博客分类与博客标签标准](./documents/Tag.md)   | 该文档对 **中文博客列表导航** 的 **标签分类系统** 进行说明 |
+| [常用标签含义说明](./documents/Explain/Tags.md) |    对常见的（除了使用技术栈命名的标签）标签进行解释说明    |
 
-在收录之后我们通过人工的方式对博客的相关信息进行完善（博客网站地图、博客订阅链接、博客标签等信息）
+欢迎您对项目文档提出意见或建议，我们会考虑您的提议，来不断完善本项目的各种标准和流程。
 
-### 项目相关标准
+## 支持我们
 
-我们对项目实行的相关标准和流程公示如下：
+如果您喜欢本项目，不妨通过以下方式支持该项目：
+
+1. 您可以在项目中搜索您的博客，若未收录，您可以在 Issue 中找到申请添加的链接，若已收录，您可以在 Issue 中找到信息完善的选项，帮助我们完善您博客的相关信息。
+2. 您可以为本仓库点一个 Star。
+3. 您可以为本项目做宣传，让更多博主知道本项目。
+4. 您可以加入本项目的技术组或者维护组，对本项目进行维护。
+
+> 若您有博客申请收录、博客信息修改、博客失效反馈、博客信息完善、项目 BUG 反馈、项目功能建议等内容需要与项目组进行反馈，您可以前往 [Issues · zh-blogs/blog-daohang](https://github.com/zh-blogs/blog-daohang/issues/new/choose) 选择对应的模板进行反馈
+>
+> 参与本项目相关标准构建，请参考：[项目标准贡献](./CONTRIBUTING.md)
+>
+> 参与 V3 版本前端开发，请参考：[V3 版本前端贡献](https://github.com/zh-blogs/V3-frontend/blob/main/CONTRIBUTING.md)
+>
+> 参与 V3 版本后端开发，以及加入项目维护组请通过上方 **Issue 选项卡中的加入我们** 与我们联系
 
-|               标准名称               |                           标准说明                           |
-| :----------------------------------: | :----------------------------------------------------------: |
-| [博客定义](./document/Definition.md) |           本项目对于个人博客的定义、博客收录的标准           |
-|  [博客收录](./document/Included.md)  | 维护组收录的博客说明、自主提交博客收录的说明、对项目收录上游库进行说明 |
-|  [精选博客](./document/Selected.md)  |               本项目对精选博客的定义和筛选说明               |
-|    [博客分类](./document/Tag.md)     |             本项目对于博客的分类和博客 Tag 说明              |
+## 维护成员名单（排名不分先后）
 
-您可以阅读以上项目的部分细则，也欢迎您对部分细则提出建议或意见，用以不断完善相关标准和流程。
+> 本项目尊重维护人员个人意愿，根据维护人员个人情况决定对项目是否继续进行维护。
+>
+> 依照 [项目维护意向调查 Issue #24](https://github.com/zh-blogs/blog-daohang/issues/24)
+>
+> 感谢对本项目做出贡献的各位维护人员，你们的付出是对本项目最大的支持和鼓励。
 
-### 感谢以下成员对本项目的贡献（按照首字母排序）
+现项目维护人员：
 
-| 项目技术组（负责项目程序开发与维护） | 列表维护组（负责列表数据维护） |
-| :--------: | :--------: |
-|   [Innei](https://github.com/Innei)    |   [Dian-C](https://github.com/Dian-C)   |
-|  [jsun969](https://github.com/jsun969)   |  [huziyan1](https://github.com/huziyan1)  |
-| [OhYee（项目技术组负责人）](https://github.com/OhYee) | [jonepengcn](https://github.com/jonepengcn) |
-|   [soxft（项目技术组负责人）](https://github.com/soxft)   |  [Kagurain](https://github.com/Kagurain)  |
-|   [wibus-wee](https://github.com/wibus-wee)   | [liangmis](https://github.com/liangmis)  |
-| [zkeq](https://github.com/zkeq) | [linlinzzo（列表维护组负责人）](https://github.com/linlinzzo) |
-|        |   [MYXXTS（列表维护组负责人）](https://github.com/MYXXTS)   |
-|            | [Timozaici](https://github.com/Timozaici)  |
-|            | [gtxykn0504](https://github.com/gtxykn0504)  |
-|            | [Lafcadia](https://github.com/Lafcadia)  |
-|            | [澄沨](https://github.com/aquausora)  |
+> 技术组：负责对本项目的相关程序进行开发和维护，包括但不限于项目的前端、后端、数据同步工具等。
+>
+> 维护组：负责对本项目的项目数据进行维护，包括但不限于项目博客审核、信息完善、标准完善等。
 
-### 感谢以下网站对本项目的宣传
+|                      技术组                       |                            维护组                            |
+| :-----------------------------------------------: | :----------------------------------------------------------: |
+| [OhYee（技术组负责人）](https://github.com/OhYee) | [linlinzzo（项目整体负责人、维护组负责人）](https://github.com/linlinzzo) |
+| [soxft（技术组负责人）](https://github.com/soxft) | [MYXXTS（维护组负责人、项目标准制定人）](https://github.com/MYXXTS) |
+|         [Mabbs](https://github.com/Mabbs)         |          [aquausora](https://github.com/aquausora)           |
+|     [wibus-wee](https://github.com/wibus-wee)     |         [gtxykn0504](https://github.com/gtxykn0504)          |
+|    [liangmiQwQ](https://github.com/liangmiQwQ)    |           [Lafcadia](https://github.com/Lafcadia)            |
+|     [Redish101](https://github.com/Redish101)     |                                                              |
+
+前项目维护人员：
+
+[@Innei](https://github.com/Innei) [@jsun969](https://github.com/jsun969) [@zkeq](https://github.com/zkeq) [@Dian-C](https://github.com/Dian-C) [@huziyan1](https://github.com/huziyan1) [@jonepengcn](https://github.com/jonepengcn) [@Kagurain](https://github.com/Kagurain) [@liangmis](https://github.com/liangmis) [@Timozaici](https://github.com/Timozaici) [@Changrui0101](https://github.com/Changrui0101) [@Lfhsheng](https://github.com/Lfhsheng) [@hydrogenoxide-user](https://github.com/hydrogenoxide-user) [@Innei](https://github.com/Innei) [@Amitabha](https://github.com/Amitabha)  [@waterelegance](https://github.com/waterelegance)  [@linhaii](https://github.com/linhaii) [@yzqzss](https://github.com/yzqzss) [@hilllei](https://github.com/hilllei)
+
+## 感谢以下网站对本项目的宣传
 
 [友链 – 阿锋的小宇宙 (feng.pub)](https://feng.pub/links)
 
 [中文独立博客圈 - 博客志 (jetli.com.cn)](http://www.jetli.com.cn/quan.html)
 
 [中文博客列表导航项目 - 杜老师说 (dusays.com)](https://dusays.com/494/)
 
-[友情链接 · 雅余 · 茶余饭后，闲情雅致 (yayu.net)](https://www.yayu.net/links/)
-
-[左邻右舍 - HONG的小站 (hongweblog.com)](https://hongweblog.com/friend)
-
 [谈谈几个博客聚合网站，以及个人推荐 – 铎鸣也 (wordpress.com)](https://zhengduo.wordpress.com/2022/12/09/zh-blogs-site-link/)
 
-[万亿及秭 - peachRL的小站 (wanyijizi.com)](https://wanyijizi.com/)
+[万亿及秭 - peachRL 的小站 (wanyijizi.com)](https://wanyijizi.com/)
diff --git a/assets/logo.png b/assets/logo.png