From 4c84a4c54b8c1cc9a2d8e93229d9909b3e4f1093 Mon Sep 17 00:00:00 2001
From: camera-2018 <2907618001@qq.com>
Date: Tue, 15 Aug 2023 01:17:42 +0800
Subject: [PATCH] docs: update contributing

---
 CONTRIBUTING.md | 225 ++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 208 insertions(+), 17 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 27fcef1..ed57df8 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,15 +1,20 @@
 # 贡献指南
-感谢您的贡献，并感谢您在执行此操作之前阅读此文档！
+
+感谢您的贡献，并感谢您在执行贡献操作之前阅读此文档！
 
 ## 致新贡献者
+
 欢迎你的到来，非常感谢你愿意一起建设 HDU-CS-WIKI 💖。
 
 初次参与，你遇到任何问题都可以直接反馈到本仓库，包括但不限于：
-  - 开发环境搭建时遇到任何问题。
-  - 文档遇到任何问题（笔误，格式，错误等）。
+
+- 开发环境搭建时遇到任何问题。
+- 文档遇到任何问题（笔误，格式，错误等）。
+
 如果你在运行项目的时候发现任何不符合预期或不合理的地方，请直接提交 Issue 反馈和 Bug 报告！
 
 ## 如何贡献
+
 我们欢迎各种贡献，包括但不限于：
 
 - 新功能（Feature）
@@ -21,32 +26,214 @@
 - 在各种媒体、博客文章、群内宣传 HDU-CS-WIKI
 
 ## 文档风格
+
 1. 使用 Markdown 编写文档，文档格式参考 Markdown 语法。
 2. 一个页面只有一个1级标题（H1，一个#），其他标题从2级开始（H2，##）。
 3. 本项目自动在英文与中文、数字与中文之间添加空格。
+
    ```markdown
     AI 与人工智能，AGI 的发展方向。
    ```
+
 4. 标题内的英文单词首字母大写。
-5. 代码块使用 ` ``` ` 包裹，并标注常见的语言标识符，如 ` ```python `。
+5. 代码块使用 ` ``` ` 包裹，并标注常见的语言标识符，如 ` ```python ` ，其作用是使代码正常高亮。
+::: details 代码高亮支持的语言
+
+```ts
+export type Lang =
+  | 'abap'
+  | 'actionscript-3'
+  | 'ada'
+  | 'apache'
+  | 'apex'
+  | 'apl'
+  | 'applescript'
+  | 'ara'
+  | 'asm'
+  | 'astro'
+  | 'awk'
+  | 'ballerina'
+  | 'bat' | 'batch'
+  | 'beancount'
+  | 'berry' | 'be'
+  | 'bibtex'
+  | 'bicep'
+  | 'blade'
+  | 'c'
+  | 'cadence' | 'cdc'
+  | 'clarity'
+  | 'clojure' | 'clj'
+  | 'cmake'
+  | 'cobol'
+  | 'codeql' | 'ql'
+  | 'coffee'
+  | 'cpp'
+  | 'crystal'
+  | 'csharp' | 'c#' | 'cs'
+  | 'css'
+  | 'cue'
+  | 'cypher' | 'cql'
+  | 'd'
+  | 'dart'
+  | 'dax'
+  | 'diff'
+  | 'docker' | 'dockerfile'
+  | 'dream-maker'
+  | 'elixir'
+  | 'elm'
+  | 'erb'
+  | 'erlang' | 'erl'
+  | 'fish'
+  | 'fsharp' | 'f#' | 'fs'
+  | 'gdresource'
+  | 'gdscript'
+  | 'gdshader'
+  | 'gherkin'
+  | 'git-commit'
+  | 'git-rebase'
+  | 'glimmer-js' | 'gjs'
+  | 'glimmer-ts' | 'gts'
+  | 'glsl'
+  | 'gnuplot'
+  | 'go'
+  | 'graphql'
+  | 'groovy'
+  | 'hack'
+  | 'haml'
+  | 'handlebars' | 'hbs'
+  | 'haskell' | 'hs'
+  | 'hcl'
+  | 'hjson'
+  | 'hlsl'
+  | 'html'
+  | 'http'
+  | 'imba'
+  | 'ini' | 'properties'
+  | 'java'
+  | 'javascript' | 'js'
+  | 'jinja-html'
+  | 'jison'
+  | 'json'
+  | 'json5'
+  | 'jsonc'
+  | 'jsonl'
+  | 'jsonnet'
+  | 'jssm' | 'fsl'
+  | 'jsx'
+  | 'julia'
+  | 'kotlin'
+  | 'kusto' | 'kql'
+  | 'latex'
+  | 'less'
+  | 'liquid'
+  | 'lisp'
+  | 'logo'
+  | 'lua'
+  | 'make' | 'makefile'
+  | 'markdown' | 'md'
+  | 'marko'
+  | 'matlab'
+  | 'mdx'
+  | 'mermaid'
+  | 'mojo'
+  | 'narrat' | 'nar'
+  | 'nextflow' | 'nf'
+  | 'nginx'
+  | 'nim'
+  | 'nix'
+  | 'objective-c' | 'objc'
+  | 'objective-cpp'
+  | 'ocaml'
+  | 'pascal'
+  | 'perl'
+  | 'php'
+  | 'plsql'
+  | 'postcss'
+  | 'powerquery'
+  | 'powershell' | 'ps' | 'ps1'
+  | 'prisma'
+  | 'prolog'
+  | 'proto'
+  | 'pug' | 'jade'
+  | 'puppet'
+  | 'purescript'
+  | 'python' | 'py'
+  | 'r'
+  | 'raku' | 'perl6'
+  | 'razor'
+  | 'reg'
+  | 'rel'
+  | 'riscv'
+  | 'rst'
+  | 'ruby' | 'rb'
+  | 'rust' | 'rs'
+  | 'sas'
+  | 'sass'
+  | 'scala'
+  | 'scheme'
+  | 'scss'
+  | 'shaderlab' | 'shader'
+  | 'shellscript' | 'bash' | 'sh' | 'shell' | 'zsh'
+  | 'shellsession' | 'console'
+  | 'smalltalk'
+  | 'solidity'
+  | 'sparql'
+  | 'splunk' | 'spl'
+  | 'sql'
+  | 'ssh-config'
+  | 'stata'
+  | 'stylus' | 'styl'
+  | 'svelte'
+  | 'swift'
+  | 'system-verilog'
+  | 'tasl'
+  | 'tcl'
+  | 'tex'
+  | 'toml'
+  | 'tsx'
+  | 'turtle'
+  | 'twig'
+  | 'typescript' | 'ts'
+  | 'v'
+  | 'vb' | 'cmd'
+  | 'verilog'
+  | 'vhdl'
+  | 'viml' | 'vim' | 'vimscript'
+  | 'vue-html'
+  | 'vue'
+  | 'vyper' | 'vy'
+  | 'wasm'
+  | 'wenyan' | '文言'
+  | 'wgsl'
+  | 'wolfram'
+  | 'xml'
+  | 'xsl'
+  | 'yaml' | 'yml'
+  | 'zenscript'
+  | 'zig'
+```
+
+:::
 
 ::: tip 🤓 注意
 尽量不要使用 `typora` 因为它的渲染效果和本项目前端框架 `vitepress` 不一致。
-在 `typora` 中编辑完成后，确认一下 .md 文件源代码是否为正常 Markdown 。
-编辑完成后尽量启动本项目在前端查看效果。
-:::
 
+在 `typora` 中编辑完成后，确认一下 .md 文件源代码是否为正常 Markdown 。
+
+编辑完成后需要启动本项目在前端查看效果。
+:::
 
 ## 项目构建指南
 
-需要 nodejs v16.14.0 及以上版本
+vitepress 框架要求，强制需要 nodejs v18.0 及以上版本。
 
-使用包管理器 npm
+本项目使用包管理器 npm。
 
 ```bash
 npm install 
-npm run docs:dev  #运行预览环境
+npm run docs:dev      #运行预览环境
 ```
+
 ```bash
 npm run docs:build    #编译线上环境
 npm run docs:preview  #预览线上环境
@@ -62,11 +249,13 @@ npm run docs:preview  #预览线上环境
 
 注意尽量不要使用 `img` 标签，因为经前端构建解析后路径会不正确。
 
-后续会统一放置到 oss 存储桶中。
+后续会统一放置到 cos 存储桶中。
 
 ## 项目配置指南
 
-修改新添加或移动位置的 md 文件需要在 `.vitepress/config.js` 中的 `sidebar` 中添加或修改对应的配置。
+修改新添加或移动位置的 md 文件需要在 `.vitepress/config.js`、`.vitepress/sidebar.js` 中添加或修改对应的配置。
+
+> sidebar.js 文件会管理显示在左侧导航栏的所有路由
 
 详见 [VitePress 官方文档](https://vitepress.dev/reference/default-theme-sidebar)
 
@@ -117,9 +306,10 @@ subject为commit概述
 
 其中详细内容可以参照 [约定式提交](https://www.conventionalcommits.org/zh-hans/v1.0.0/)
 
-[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
+![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)
 
 ## Pull Request 流程与指南
+
 Fork 本仓库，然后在你的仓库中进行修改，修改完成后在本仓库创建 NEW Pull Request ，选择 compare across forks 提交 pr 并评论上你修改的具体信息即可，我们会第一时间审阅并合并。
 
 ## Feature
@@ -128,18 +318,19 @@ Fork 本仓库，然后在你的仓库中进行修改，修改完成后在本仓
     ```latex
     $行内公式\arccos{a}$
     ```
-    会渲染成 $\arccos{a}$
+    > 会渲染成 $\arccos{a}$
     ```latex
     $$单行公式\arcsin{b}$$
     ```
-    会渲染成
-    $$\arcsin{b}$$
+    > 会渲染成
+    >
+    > $$\arcsin{b}$$
     ::: tip
     Latex语法在线编辑器 https://www.latexlive.com
     :::
 
 2. 支持Mermaid流程图，格式如下
-    ```txt
+    ```markdown
         ```mermaid
         graph TD;
         A-->B;