Browse Source

docs: 更新贡献者文档并升级依赖 (#31)

- 添加关闭GitHub匿名邮箱的说明
- 在多个文档中添加PR提交前的匿名邮箱检查提醒
- 升级vuepress相关依赖版本到2.0.0-rc.20

Signed-off-by: longjin <longjin@DragonOS.org>
LoGin 1 day ago
parent
commit
efb840ba8b
4 changed files with 16 additions and 5 deletions
  1. 10 1
      contributors/cheat-sheet.md
  2. 1 0
      contributors/github-workflow.md
  3. 2 2
      contributors/pull-requests.md
  4. 3 2
      package.json

+ 10 - 1
contributors/cheat-sheet.md

@@ -1,4 +1,13 @@
 # 贡献者备忘录
 
 
-// TODO
+## 关掉匿名邮箱 <!-- {#disable-anonymous-email} -->
+
+由于您需要与他人协作,GitHub自带的匿名邮箱功能可能会导致一些问题。
+请您在提交PR前关闭这个功能,否则您的PR将无法通过审查。
+
+**如何关闭匿名邮箱?**
+
+1. 打开 GitHub 网站并登录您的账户。
+2. 打开[Email settings](https://github.com/settings/emails)页面。
+3. 在"Primary email address"下找到"Keep my email addresses private",取消勾选该选项。

+ 1 - 0
contributors/github-workflow.md

@@ -103,5 +103,6 @@ git push zhangsan patch-my-feature
 1. 打开你在GitHub上Fork的仓库 `https://github.com/<username>/DragonOS`
 2. 点击右上角的`Compare & Pull Request`按钮,然后选择分支`patch-my-feature`,目标为社区主仓库的`master`分支(或`main`分支)。
 3. 关于Pull Request的进一步要求,请查看[Pull Request流程介绍]
+4. 请注意:在提交PR前,请确保您已[关闭GitHub的匿名邮箱功能](./cheat-sheet.md#关掉匿名邮箱),否则您的PR将无法通过审查。
 
 [Pull Request流程介绍]: /contributors/pull-requests.md

+ 2 - 2
contributors/pull-requests.md

@@ -17,6 +17,8 @@
 
 **确保您的拉取请求符合我们的最佳实践。这些实践包括遵循项目规范、提交小的拉取请求以及充分注释。**
 
+请注意:在提交PR前,请确保您已[关闭GitHub的匿名邮箱功能](./cheat-sheet.md#关掉匿名邮箱),否则您的PR将无法通过审查。
+
 
 ### 运行本地的测试
 
@@ -327,5 +329,3 @@ DragonOS社区使用`@dragonosbot`来执行自动化的工作流。
 [为DragonOS社区作出贡献]: /contributors/README.md
 [社区沟通渠道]: /communication/README.md
 [代码风格指南]: /contributors/code-style.md
-
-

+ 3 - 2
package.json

@@ -18,8 +18,9 @@
   },
   "homepage": "https://github.com/DragonOS-Community/Community#readme",
   "devDependencies": {
-    "@vuepress/bundler-vite": "^2.0.0-rc.14",
+    "@vuepress/bundler-vite": "^2.0.0-rc.20",
     "@vuepress/theme-default": "^2.0.0-rc.37",
-    "vuepress": "^2.0.0-rc.14"
+    "sass-embedded": "^1.89.0",
+    "vuepress": "^2.0.0-rc.20"
   }
 }