From 9574144767a2d7e3e253bf176ec7a8a46facdd78 Mon Sep 17 00:00:00 2001 From: Feng Gao Date: Wed, 3 Dec 2025 11:00:30 +0800 Subject: [PATCH] Update join.md --- src/wiki/about/join.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/src/wiki/about/join.md b/src/wiki/about/join.md index f403c76..b7a4e62 100644 --- a/src/wiki/about/join.md +++ b/src/wiki/about/join.md @@ -2,14 +2,16 @@ 非常感谢你查看这份指南并着手分享你的经验！我们相信，每个人的经历都有其独特的价值，无论是学习、成长、转折还是挑战，无论是成功亦或一时的失意，你的故事都可能照亮他人的道路！ -### 你可以贡献什么？ +## 1、你可以贡献什么？ - 更新或撰写某个主题的指南，分享自己的经历 - 修正错别字、术语错误、逻辑不清 - 添加实用资源、推荐书籍、网站、工具等 - 提出建议、反馈问题、审阅 PR、参与维护 -### 分享方式 +
+ +## 2、分享方式 分享经历、修正内容、增添内容请遵循以下方式 ( 实名和匿名均可 ) ： @@ -23,7 +25,7 @@ 本指南通过 `VitePress` 搭建，部署到 `github pages` 上，所以同样支持一些扩展的 Markdown 语法，如果你想使用这些语法或了解 `VitePress` 可以参考这两份手册： [Markdown 扩展语法](https://vitepress.dev/zh/guide/markdown) 、 [VitePress 使用手册](https://vitepress.dev/zh/) -#### 本地编辑，git 上传 ( 强烈推荐 ) +### 2.1 本地编辑，git 上传 ( 强烈推荐 ) 这里假定你已经能够使用 `github` 以及 `git` 工具，如果你不了解想要学习可以去网上查找资料或询问 AI。 @@ -34,7 +36,6 @@ 5. 提交修改并且 push 到你的仓库 ( 这里 `origin` 是不需要手动设置的，克隆之后会自动设置为你自己的 `fork` 仓库 ) - ``` git add . git commit -m "something" @@ -44,7 +45,7 @@ git push origin feat/你的修改描述以及名字 ( 可以匿名 ) 1. 打开你的 `github` 仓库的 `fork` 仓库页面，看到一个绿色按钮 `Compare & pull request`，点击它进行 PR，记得填写 PR 说明，简要说明你的修改，最后提交 PR 2. 等待审核完毕后，你的更新就会被发表，这种方式更新，你会进入 `github` 仓库的贡献者列表。 -#### 直接编辑 github 页面 +### 2.2 直接编辑 github 页面 1. 访问 仓库 并直接进入你分享内容所在文件夹，所有文档均在 `/docs/pages` 这一路径下，找到你要访问的对应版块 2. 点击右上角的 `Add file` 上传你已经写好的文件 @@ -52,11 +53,13 @@ git push origin feat/你的修改描述以及名字 ( 可以匿名 ) 4. 点击 `Propose changes`，记得描述一下你的内容，确保侧边栏中的 `Allow edits from maintainers` 被勾选。 5. 点击 `Create pull request`。至此即可成功编辑，等待审核完成即可发布 -### 更新规则 +
+ +## 3、更新规则 对指南的更新请遵循下面的规则： -#### 题目和署名 +### 3.1 题目和署名 保研、考研、留学、工作四大版块文章标题（即 Markdown 一级标题）按照如下规则书写，其他标题不限制： @@ -79,7 +82,7 @@ xx级 xxx（匿名可以不写）+ 去向 去向尽量写，不想透露也可， -#### 文件增删改 +### 3.2 文件增删改 Markdown 文件的第一个一级标题会作为目录中的标题进行展示。如果要在标题添加 `emoji` 建议添加到开头，方便整理。 @@ -89,7 +92,7 @@ Markdown 文件的第一个一级标题会作为目录中的标题进行展示 如果你不知道如何编辑，可以直接上传，我们会帮你整理好格式。后面会更新一个自动维护这个地址的脚本，前面大家弄不好可以直接告诉我们，我们会帮你整理。但还是希望大家规范格式，减少工作量。 -#### 版块添加 +### 3.3 版块添加 如果你要创建新的版块，就要创建一个新的文件夹，并在文件夹下创建 `README.md` 文件，在其中描述版块的内容和主题，版块内容同样放在文件夹下，如果你上传了图片，同样参考上面的方式。上传后脚本会自动添加版块并更新你上传的内容。新建版块参考如下目录结构： @@ -104,12 +107,12 @@ fileFolderName 如果你采用的 `Fork-clone-PR` 方式，将文件夹添加到 `/docs/pages` 里或者其中已有版块文件夹下并提交。否则将其打包后连带资源文件一并发送至我们的联系邮箱即可。 -### 遇到问题？ +## 4、遇到问题？ 在项目页面点击 `Issues` 提交问题，目前有两种模板可用，一个用于提交 bug,一个用于提出建议，请根据具体情况进行提交。 我们一定会认真听取大家的建议，并及时解决大家遇到的问题，将这份指南做得更好。 -### 参与维护，参与审核 +## 5、参与维护，参与审核 -非常希望有更多了解 `VitePress` 相关的技术 ( 比如 `CSS`、`Vue` 等 ) 的同学加入我们，同我们一起维护这个项目。如果你想加入我们，直接发送邮件到我们的邮箱即可。 +非常希望有更多同学加入我们，同我们一起维护这个项目。如果你想加入我们，直接发送邮件到我们的邮箱：gaofeng@ouc.edu.cn 。