From b9f5edd3bb5bd3c1bbb45be527b4ab7dc9bdbf35 Mon Sep 17 00:00:00 2001
From: camera-2018 <2907618001@qq.com>
Date: Sat, 22 Apr 2023 00:37:47 +0800
Subject: [PATCH] docs: typo
---
CONTRIBUTING.md | 38 +++++++++++++++++++-------------------
contributors.md | 22 +++++++++++++++++++---
使用指南.md | 10 +++++-----
简介.md | 46 +++++++++++++++++++++++-----------------------
4 files changed, 66 insertions(+), 50 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d3b12d9..a4477f7 100644
--- 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 并评论上你修改的具体信息即可，我们会第一时间审阅并合并。
\ No newline at end of file
+Fork 本仓库，然后在你的仓库中进行修改，修改完成后在本仓库创建 NEW Pull Request ，选择 compare across forks 提交 pr 并评论上你修改的具体信息即可，我们会第一时间审阅并合并。
\ No newline at end of file
diff --git a/contributors.md b/contributors.md
index f4716a6..3fb7ed3 100644
--- a/contributors.md
+++ b/contributors.md
@@ -4,15 +4,31 @@ import { members } from './members.ts'
-# Our Team
+# 贡献者名单
-Say hello to our awesome team.
+以下为对本项目做出贡献的人员名单，排名不分先后。
+## 特别鸣谢
+
+以下为对本项目做出贡献的组织名单，排名不分先后。
+
+杭州电子科技大学计算机科协
+
+杭州电子科技大学Student Research Training （SRT）
+
+杭州电子科技大学 PaddlePaddle 领航团
+
+杭州电子科技大学杭电助手
+
+杭州电子科技大学信息安全协会 （Vidar Team）
+
+Microchip 杭州电子科技大学 大学生科技创新孵化器实验室
+