docs: typo

2023-04-22 00:37:47 +08:00
parent 17eb39c3f7
commit b9f5edd3bb
4 changed files with 66 additions and 50 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -6,25 +6,25 @@

 初次参与，你遇到任何问题都可以直接反馈到本仓库，包括但不限于：
  - 开发环境搭建时遇到任何问题。
-  - 文档遇到任何问题。
-如果你在运行项目的时候发现任何不符合预期或不合理的地方，请直接提交 Issue反馈和 Bug 报告！
+  - 文档遇到任何问题（笔误，格式，错误等）。
+如果你在运行项目的时候发现任何不符合预期或不合理的地方，请直接提交 Issue 反馈和 Bug 报告！

 ## 如何贡献
 我们欢迎各种贡献，包括但不限于：

- 新功能（feature）
+- 新功能（Feature）
 - 代码构建、CI/CD
 - Bug 修复
 - 文档内容增删改
 - Issue 分类、发起、回复、管理、维护
 - 网站页面设计
- 在各种媒体、博客文章宣传 HDU-CS-WIKI
+- 在各种媒体、博客文章、群内宣传 HDU-CS-WIKI

-## 如何使用Git和Github
+## 如何使用 Git 和 Github

 详见 [3.5 Git和Github](https://hdu-cs.wiki/3.%E7%BC%96%E7%A8%8B%E6%80%9D%E7%BB%B4%E4%BD%93%E7%B3%BB%E6%9E%84%E5%BB%BA/3.5git%E4%B8%8Egithub.html)

-## commit message 规范
+## Commit Message 规范

 本项目遵循以下 commit message 规范：

@@ -33,20 +33,20 @@
 type(scope): subject

 type为commit的类型
-    feat: 新特性
-    fix: 修改问题
-    refactor: 代码重构
-    docs: 文档修改
-    style: 代码格式修改
-    test: 测试用例修改
-    chore: 其他修改, 比如构建流程, 依赖管理.
-    pref: 性能提升的修改
-    build: 对项目构建或者依赖的改动
-    ci: CI 的修改
-    revert: revert 前一个 commit(撤销前一个commit)
+    feat:      新特性
+    fix:       修改问题
+    refactor:  代码重构
+    docs:      文档修改
+    style:     代码格式修改
+    test:      测试用例修改
+    chore:     其他修改, 比如构建流程, 依赖管理
+    pref:      性能提升的修改
+    build:     对项目构建或者依赖的改动
+    ci:        CI 的修改
+    revert:    revert 前一个 commit(撤销前一个commit)
    
 scope是文件名 / 模块名 / 影响的范围
-    例如 schoolSchedule
+    例如  schoolSchedule
    
 subject为commit概述
    建议符合 50 / 72 formatting
@@ -59,4 +59,4 @@ subject为commit概述
 ```

 ## Pull Request 流程与指南
-Fork 本仓库，然后在你的仓库中进行修改，修改完成后在本仓库创建NEW Pull Request,选择 compare across forks 提交 pr 并评论上你修改的具体信息即可，我们会第一时间审阅并合并。
+Fork 本仓库，然后在你的仓库中进行修改，修改完成后在本仓库创建 NEW Pull Request ，选择 compare across forks 提交 pr 并评论上你修改的具体信息即可，我们会第一时间审阅并合并。
--- a/contributors.md
+++ b/contributors.md
@@ -4,15 +4,31 @@ import { members } from './members.ts'

 </script>

-# Our Team
+# 贡献者名单

-Say hello to our awesome team.
+以下为对本项目做出贡献的人员名单，排名不分先后。

 <VPTeamMembers size="small" :members="members" />

+## 特别鸣谢
+
+以下为对本项目做出贡献的组织名单，排名不分先后。
+
+<div id="team">杭州电子科技大学计算机科协</div>
+<br/>
+<div id="team">杭州电子科技大学Student Research Training （SRT）</div>
+<br/>
+<div id="team">杭州电子科技大学 PaddlePaddle 领航团</div>
+<br/>
+<div id="team">杭州电子科技大学杭电助手</div>
+<br/>
+<div id="team">杭州电子科技大学信息安全协会 （Vidar Team）</div>
+<br/>
+<div id="team">Microchip 杭州电子科技大学 大学生科技创新孵化器实验室</div>
+<br/>

 <style>
-.affiliation > .title, .profile > .data > .name{
+.affiliation > .title, .profile > .data > .name, #team {
  font-weight: bold !important;
  color: transparent;
  background: -webkit-linear-gradient(
--- a/使用指南.md
+++ b/使用指南.md
@@ -1,10 +1,10 @@
 # 使用指南
- 推荐使用`暗色模式`，以获得更好的阅读体验。点击右上角切换按钮即可切换。
+- 推荐使用 `暗色模式` ，以获得更好的阅读体验。点击右上角切换按钮即可切换。

- 电脑端推荐按`Ctrl + 加号`将页面放大到 150% 以便于阅读。
+- 电脑端推荐按 `Ctrl + 加号` 将页面放大到 150% 以便于阅读。

- 按`Ctrl + 0`可快速将页面缩小回 100% 。
+- 按 `Ctrl + 0` 可快速将页面缩小回 100% 。

- 使用`Ctrl + F`快速搜索在某一页面的内容。
+- 使用 `Ctrl + F` 快速搜索在某一页面的内容。

- 使用`Ctrl + K`唤起搜索框，输入关键词即可快速搜索整个 wiki 。
+- 使用 `Ctrl + K` 唤起搜索框，输入关键词即可快速搜索整个 wiki 。
--- a/简介.md
+++ b/简介.md
@@ -1,61 +1,61 @@
 # HDU计算机科学讲义
-# 序言
+## 序言

 初入大学，大家都会十分迷茫，尤其是计算机相关的同学们。

 **我们会面临着各种各样的问题**：编程从哪里学起？如何高效利用大学时间？如何平衡绩点与项目经验？如何正确安排学习配比？有没有人带带弟弟？如何问大佬问题得到回复的概率更高？

-**我们会被信息洪流所淹没**：C语言、Go、Java、Python；人工智能、机器学习、pytorch、tensorflow；数据库、操作系统、计算机网络；Linux、Git。哪个应该马上学，哪个应该多学，哪个只要会用就行？
+**我们会被信息洪流所淹没**：C语言、Go、Java、Python；人工智能、机器学习、Pytorch、tensorflow；数据库、操作系统、计算机网络；Linux、Git。哪个应该马上学，哪个应该多学，哪个只要会用就行？

 **我们面临各种各样的抉择**：搞开发还是搞科研，毕业直接工作还是考研？搞开发的话去做前端还是后端，哪里去找项目？搞研究的话怎么去联系实验室，又如何入门人工智能？要不要去参加竞赛，有哪些竞赛，如何挑选队友？

 学长学姐们深知其中痛楚，在我们踩了一个个坑后，我们决定：

- **出一份计算机科学领域的讲义，一起做大家的领路人。** 
+**出一份计算机科学领域的讲义，一起做大家的领路人。** 

-这份讲义由**zzm**发起，**孵化器**，**SRT,杭电助手**与 **vidar team** 协办。参与讲义制作的有 hdu 的同学，老师，相关领域的大佬，覆盖了人工智能入门、软件开发入门，计算机学习之道与路线等内容。
+这份讲义由 **zzm** 发起，**孵化器**，**SRT，杭电助手** 与 **vidar team** 协办。参与讲义制作的有 HDU 的同学，老师，相关领域的大佬，覆盖了人工智能入门、软件开发入门，计算机学习之道与路线等内容。

-zzm花费了一年的时间动员了大伙对讲义进行修缮和完备，不得不说这确实不是一个小的工作，不过在2023年3月，在计院领导的支持下，计算机学院科协成立了。我们将在学院的支持下继续完善这个内容，同时也欢迎大伙加入我们，共同参与到讲义的学习与撰写中来！
+zzm 花费了一年的时间动员了大伙对讲义进行修缮和完备，不得不说这确实不是一个小的工作，不过在 2023 年 3 月，在计院领导的支持下，计算机学院科协成立了。我们将在学院的支持下继续完善这个内容，同时也欢迎大伙加入我们，共同参与到讲义的学习与撰写中来！

 ![](hdu-cs-qq.png)
-<center>欢迎加群669895692</center>
+欢迎加群 669895692

-::: tip
-# 为什么我要花大量的时间与折磨受这样的训练？
+::: tip 🤔
+#### **为什么我要花大量的时间与折磨受这样的训练？**

-因为你来大学的主要目的，就是进行学习，而学校的传授的内容往往是不能满足成为一个合格的CSer的全部需求的。
+因为你来大学的主要目的，就是进行学习，而学校的传授的内容往往是不能满足成为一个合格的 CSer 的全部需求的。

-再在这里贴上我的偶像蒋老师和etone的一段话！
+再在这里贴上我的偶像蒋老师和 etone 的一段话！

-我们都是活生生的人, 从小就被不由自主地教导用最小的付出获得最大的得到, 经常会忘记我们究竟要的是什么. 我承认我完美主义, 但我想每个人心中都有那一份求知的渴望和对真理的向往, "大学"的灵魂也就在于超越世俗, 超越时代的纯真和理想 -- 我们不是要讨好企业的毕业生, 而是要寻找改变世界的力量. -- jyy
+我们都是活生生的人， 从小就被不由自主地教导用最小的付出获得最大的得到， 经常会忘记我们究竟要的是什么。 我承认我完美主义， 但我想每个人心中都有那一份求知的渴望和对真理的向往， "大学"的灵魂也就在于超越世俗， 超越时代的纯真和理想 —— 我们不是要讨好企业的毕业生， 而是要寻找改变世界的力量。 —— jyy
+
+教育除了知识的记忆之外， 更本质的是能力的训练， 即所谓的 training。 而但凡 training 就必须克服一定的难度， 否则你就是在做重复劳动， 能力也不会有改变。 如果遇到难度就选择退缩， 或者让别人来替你克服本该由你自己克服的难度， 等于是自动放弃了获得 training 的机会， 而这其实是大学专业教育最宝贵的部分。 —— etone

-教育除了知识的记忆之外, 更本质的是能力的训练, 即所谓的training. 而但凡training就必须克服一定的难度, 否则你就是在做重复劳动, 能力也不会有改变. 如果遇到难度就选择退缩, 或者让别人来替你克服本该由你自己克服的难度, 等于是自动放弃了获得training的机会, 而这其实是大学专业教育最宝贵的部分. -- etone
 :::
-
-# 学习原则
+## 学习原则

 1. 建议保持至少一半时间在实操，一半时间在学理论知识，比例未必正确的，但是强调实操和反馈的重要性，如果你上来就拿一本经典的花书看，只看理论或者上来就整一段开源代码，势必会陷入不同程度的盲目和困苦当中。
 2. 切记勿要过度深度遍历知识，知识无尽的，如果深度钻研下去，可能没有尽头，最重要的是框架，以及高频次用的知识。更为准确地说，是你要建立一个自己的知识体系，尝试抓住时代发展的脉络或者某一个知识点的延伸。如果你一个知识点无限迭代下去，可能长时间没有正反馈，一瞬间就放弃了。
-3. 对于学到的知识 一定要注重实践 不能只学习理论知识
+3. 对于学到的知识 一定要注重实践 不能只学习理论知识。

-例如学习Pytorch，应该尽快理解Pytorch编程的框架，dataloder，model，train，test文件
+    例如学习 Pytorch，应该尽快理解 Pytorch 编程的框架，dataloder，model，train，test 文件。

-例如学习学习过程中学习到Linux命令，不是需要把整本Liunx书籍全部看完后才可使用
+    例如学习学习过程中学习到 Linux 命令，不是需要把整本 Liunx 书籍全部看完后才可使用。

 4. 敢于否定，如果对于给出的学习资料看不懂，要尝试自己寻找学习资料，找到适合自己的那份学习资料。并且中文的社区包括我们，都可能会犯各种各样的错误。就连论文也不一定是对的。有写论文就是专门驳斥前人哪怕是巨佬的观点。我非常欢迎你提出异议。

-# **如何获得帮助**
+## **如何获得帮助**

-在学习和实验的过程中, 你会遇到大量的问题.除了参考我们提供的教程外，你还需要大量自行搜索资料，但是我们参考的教程又多半是英文的或者说中文社区提供的帮助比较少，因此你需要学会对英文资料的查询并尝试适应他！
+在学习和实验的过程中， 你会遇到大量的问题。除了参考我们提供的教程外，你还需要大量自行搜索资料，但是我们参考的教程又多半是英文的或者说中文社区提供的帮助比较少，因此你需要学会对英文资料的查询并尝试适应他！

 如果你心态炸了，欢迎联系学长学姐来给你做心理疏导~

 如果你感觉实在不会，也欢迎加入我们的群里进行讨论交流。

-如何适应查阅英文资料? 方法是尝试并坚持查阅英文资料.
+如何适应查阅英文资料？ 方法是尝试并坚持查阅英文资料。

-# **许可协议**
+## **许可协议**

-本作品采用`知识共享 署名-非商业性使用-相同方式共享 3.0 中国大陆`许可协议进行许可. 要查看该许可协议, 可访问[这里](http://creativecommons.org/licenses/by-nc-sa/3.0/cn/), 或者写信到 Creative Commons, PO Box 1866, Mountain View, CA 94042, USA
+本作品采用 `知识共享 署名-非商业性使用-相同方式共享 3.0 中国大陆` 许可协议进行许可。 要查看该许可协议， 可访问[这里](http://creativecommons.org/licenses/by-nc-sa/3.0/cn/)， 或者写信到 Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.

-© 2022. 此文章采用 **CC BY-NC-SA 3.0 CN** 许可授权。
+© 2022. 此文章采用 [**CC BY-NC-SA 3.0 CN**](http://creativecommons.org/licenses/by-nc-sa/3.0/cn/) 许可授权。