Skip to content

Commit

Permalink
core: --20220330 re-build folder struct
Browse files Browse the repository at this point in the history
  • Loading branch information
Jacob953 committed Mar 30, 2022
1 parent f68af69 commit 285279c
Show file tree
Hide file tree
Showing 19 changed files with 46 additions and 49 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> EvalCSU 是一个关于 CSU 的非官方专业课程经验分享平台,平台所有内容均由贡献者自愿完成
>
> 特此鸣谢 [EVALUTOR.md](docs/global/EVALUATOR.md) 以及所有 EvalCSU 的贡献者们
> 特此鸣谢 [EVALUTOR.md](global/EVALUATOR.md) 以及所有 EvalCSU 的贡献者们
- [EvalCSU](#evalcsu)
- [1 项目简介](#1-项目简介)
Expand Down Expand Up @@ -76,7 +76,7 @@ EvalCSU 建立的目的是为了帮助你节省时间,更好、更快地掌握

> 学院、专业排名不分先后
- [通用技巧经验分享](docs/global/GENERALTIPS.md)
- [通用技巧经验分享](global/GENERALTIPS.md)

- [计算机学院](docs/faculty/cse/README.md)

Expand Down Expand Up @@ -108,7 +108,7 @@ EvalCSU 建立的目的是为了帮助你节省时间,更好、更快地掌握
- 共创、共建、共享 EvalCSU 专业课程经验分享平台
- 积极响应回馈,在分享中不断学习、不断修正错误
- 严禁窃取他人成果,坚决维护所有平台贡献者的利益
- 贡献工作流程请以 [贡献指南](docs/global/zh-simplify/CONTRIBUTION.md) 作为导航
- 贡献工作流程请以 [贡献指南](global/zh-simplify/CONTRIBUTION.md) 作为导航

### 3.2 贡献者

Expand Down
14 changes: 7 additions & 7 deletions docs/faculty/cse/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@

### 2.1 评教目录

- [计算机与科学](../../evaluation/cse/science/README.md)
- [大数据](../../evaluation/cse/bigdata/README.md) - Manager: Aiden927, tangent, ...
- [信息安全](../../evaluation/cse/security/README.md) - Manager: fallme, ...
- [物联网](../../evaluation/cse/iot/README.md)
- [通信工程](../../evaluation/cse/communication/README.md) - Manager: GZHuan, .
- [软件工程](../../evaluation/cse/software/README.md) -Manger: EZ4Chen,
- [计算机与科学](/docs/evaluation/cse/science/README.md)
- [大数据](/docs/evaluation/cse/bigdata/README.md) - Manager: Aiden927, tangent, ...
- [信息安全](/docs/evaluation/cse/security/README.md) - Manager: fallme, ...
- [物联网](/docs/evaluation/cse/iot/README.md)
- [通信工程](/docs/evaluation/cse/communication/README.md) - Manager: GZHuan, .
- [软件工程](/docs/evaluation/cse/software/README.md) -Manger: EZ4Chen,

### 2.2 管理员

Expand Down Expand Up @@ -55,7 +55,7 @@
> - 低年级排序高于高年级:2020 级 > 2019 级
> - 同年级按时间顺序排:...@20220117 > ...@20220125
>
> 通用技巧可以参考 [General Tips](../../global/GENERALTIPS.md)
> 通用技巧可以参考 [General Tips](/global/GENERALTIPS.md)
jacob953@20220205
Expand Down
4 changes: 2 additions & 2 deletions docs/faculty/cse/bigdata/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- [数据科学与大数据技术](#数据科学与大数据技术)
- [专业笔记及实验](#专业笔记及实验)
- [第三学期](#第三学期)
- [数据库原理](#数据库原理)
- [数据库原理](#数据库原理)
- [第五学期](#第五学期)
- [R语言](#r语言)
- [深度学习](#深度学习)
Expand Down Expand Up @@ -54,7 +54,7 @@
> - 低年级排序高于高年级:2020 级 > 2019 级
> - 同年级按时间顺序排:...@20220117 > ...@20220125
>
> 通用技巧可以参考 [General Tips](../../global/GENERALTIPS.md),专业规划可以参考 [CSE](../README.md#3-专业规划经验分享)
> 通用技巧可以参考 [General Tips](/global/GENERALTIPS.md),专业规划可以参考 [CSE](../README.md#3-专业规划经验分享)
1. Aiden@20220205
- 大二尽早尝试科研、实习;提前规划保研、考研、留学、工作,尽早确定好方向(开发、算法)。
Expand Down
2 changes: 1 addition & 1 deletion docs/faculty/cse/security/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
> - 低年级排序高于高年级:2020 级 > 2019 级
> - 同年级按时间顺序排:...@20220117 > ...@20220125
>
> 通用技巧可以参考 [General Tips](../../global/GENERALTIPS.md),专业规划可以参考 [CSE](../README.md#3-专业规划经验分享)
> 通用技巧可以参考 [General Tips](/global/GENERALTIPS.md),专业规划可以参考 [CSE](../README.md#3-专业规划经验分享)
jacob953@20220205
Expand Down
8 changes: 4 additions & 4 deletions docs/faculty/soa/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[> Back](../../../README.md#2-项目目录)
[> Back](/README.md#2-项目目录)

# 自动化学院

Expand All @@ -15,10 +15,10 @@

### 2.1 评教目录

- [自动化](../../evaluation/soa/automation/README.md) - Manager: jzndd, ...
- [智能科学与技术](../../evaluation/soa/intelligence/README.md)
- [自动化](/docs/evaluation/soa/automation/README.md) - Manager: jzndd, ...
- [智能科学与技术](/docs/evaluation/soa/intelligence/README.md)
- 测控
- [电子信息工程](../../evaluation/soa/electronic_information/README.md) - Manager: Shanewbx, ...
- [电子信息工程](/docs/evaluation/soa/electronic_information/README.md) - Manager: Shanewbx, ...
- 电气工程及其自动化

### 2.2 评教管理者
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/global/GENERALTIPS.md → global/GENERALTIPS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[> Back](../../README.md#2-项目目录)
[> Back](/README.md#2-项目目录)

## 通用技巧

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[> Back](../../../README.md#3.1-贡献准则)
[> Back](/README.md#3.1-贡献准则)

[English](CONTRIBUTION.md) [繁體中文](CONTRIBUTION_zh_tradition.md)
## 为 EvalCSU 贡献
Expand Down Expand Up @@ -53,7 +53,7 @@

1. 进入 Issue 页面点击 `New issue` 按钮

![New issue 按钮所在的地方](../../../img/global/CONTRIBUTION/issue_button.png)
![New issue 按钮所在的地方](/img/global/CONTRIBUTION/issue_button.png)
<p align="center">Figure 1. New issue 的按钮位置</p>
2. 选择 `Bug report`, `Evaluate request`, `Feature request` 或新建一个空白模版来初始化你的 Issue
- Bug report:指出 EvalCSU 中存在的内容错误,并提出修正建议,详细请参考 [Bug report 模版](#bug-report-模版)
Expand All @@ -77,7 +77,7 @@
- 如果无其他内容, 填 `NULL.`
3.**Assign the manager you email** 中 @ 负责 bug 所在区域的管理员

![优秀的 bug issue 案例](../../../img/global/CONTRIBUTION/bug_issue_example.png)
![优秀的 bug issue 案例](/img/global/CONTRIBUTION/bug_issue_example.png)
<p align="center">Figure 2. Bug issue 的按钮位置</p>

**特别注意**
Expand Down Expand Up @@ -123,7 +123,7 @@
- 如果无其他内容, 填 `NULL.`
4. 无论是否有相应资格,都需要在 **Assign the manager you email** 中 @ 所发邮件的管理员

![优秀的 feature request 案例](../../../img/global/CONTRIBUTION/feature_request_example.png)
![优秀的 feature request 案例](../../img/global/CONTRIBUTION/feature_request_example.png)
<p align="center">Figure 3. 优秀的 feature request 案例</p>

**特别注意**
Expand All @@ -148,11 +148,11 @@
#### Pull Request 准备工作

> 可以参考 [Git 新手指南](./NOOBGUIDTOGIT.md)
> 可以参考 [Git 新手指南](NOOBGUIDTOGIT.md)
1. `fork` 主仓库到你的 GitHub 仓库中,并 `git clone` 个人仓库到本地

![fork 按钮位置](../../../img/global/CONTRIBUTION/fork_button.png)
![fork 按钮位置](/img/global/CONTRIBUTION/fork_button.png)
<p align="center">Figure 4. fork 按钮位置</p>
2. 在本地新建一个分支
- 分支命名规则:
Expand All @@ -162,7 +162,7 @@
```
- git 命令示例:
![新建分支的命令样例](../../../img/global/CONTRIBUTION/create_new_branch.png)
![新建分支的命令样例](/img/global/CONTRIBUTION/create_new_branch.png)
<p align="center">Figure 5. 新建分支的命令样例</p>
- `<type>` 建议参考 [提交类型](#evalcsu-的-commit-注意事项)
3. 在本地新建的分支上完成你的修改,修改要求详细请参考 **项目搭建原则**
Expand Down Expand Up @@ -195,13 +195,13 @@
- 若笔记不存在,则应申请添加新笔记
- 发生课改时,应在合适的 README.md 中做解释
- 评教、经验分享要求:
- 措辞中肯,评价公正,遵守 [行为准则](../../../README.md#41-行为准则)
- 措辞中肯,评价公正,遵守 [行为准则](/README.md#41-行为准则)
#### Pull Request 合并分支
1. 打开 GitHub,从个人仓库中选择 `New pull request` 按钮
![PR button](../../../img/global/CONTRIBUTION/PR_button.png)
![PR button](/img/global/CONTRIBUTION/PR_button.png)
<p align="center">Figure 6. PR 按钮</p>
2. 选取本仓库的主分支与你修改过的分支作为比较对象,依照以下方式描述你的修改:
1. 标题可以按照 `<type>[optional scope]: <description>` 的方式命名
Expand All @@ -211,14 +211,14 @@
5. 在 **Checklist** 中检查你的任务,不可缺失,但不要求一定完成
6. 在 **Screenshoot** 中贴上对应截图
![优秀的 PR 样例](../../../img/global/CONTRIBUTION/PR_example.png)
![优秀的 PR 样例](/img/global/CONTRIBUTION/PR_example.png)
<p align="center">Figure 7. 优秀的 PR 样例</p>
3. 点击 `Create pull request` 按钮创建你的合并请求
**特别注意**
- 禁止对本仓库的 gh-pages 进行任何操作
- 如果参与了评教(或经验分享)部分,请在 [EVALUATOR.md](../EVALUATOR.md) 中添加你的信息
- 如果参与了评教(或经验分享)部分,请在 [EVALUATOR.md](/global/EVALUATOR.md) 中添加你的信息
- 严禁出现个人信息,具有权威性即可
### Collaborator 协作者
Expand All @@ -227,7 +227,7 @@
1. 熟悉 [Issue 模块](#issue-模块) 和 [Pull Request 模块](#pull-request-模块) 中的所有流程
2. 禁止直接对主分支做任何操作
3. 积极维护平台环境环境,严格遵守 [贡献准则](../../../README.md#31-) 和 [行为准则](../../../README.md#41-)
3. 积极维护平台环境环境,严格遵守 [贡献准则](/README.md#31-贡献准则) 和 [行为准则](/README.md#41-行为准则)
4. 积极承担授权和审核的责任,完成授权和审核的工作
5. 积极承担 Review 的责任,完成 Review 工作
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
本指南本着以简易明了的语言向 Git & Github 新手解释基本概念与流程,如有错误和疏漏,请以谅解和更改。

更多 Git 相关操作,请参考 [Git Helper](./git-helper/README.md)
<!-- TOC -->

- [Git 新手指南](#git-新手指南)
- [零、理解基础概念](#零理解基础概念)
Expand All @@ -28,8 +27,6 @@
- [查看提交的修改](#查看提交的修改)
- [撤回提交的修改](#撤回提交的修改)

<!-- /TOC -->
--------------------
## 零、理解基础概念
Git 中需要理解基础概念:
- [工作区](#工作区)
Expand Down Expand Up @@ -82,27 +79,27 @@ Git 仓库分为两类仓库:本地仓库和远程仓库。

1. 在目标仓库点击 `Fork` 按钮,可以生成一个属于自己的同名仓库,并与上游仓库关联。

![fork](../../../img/git-helper/noodGuideToGit/fork.png)
![fork](/img/git-helper/noodGuideToGit/fork.png)

2. 操作后,可以在自己的主页看到克隆的仓库
1. 操作后,可以在自己的主页看到克隆的仓库

![fork_result](../../../img/git-helper/noodGuideToGit/fork_result.png)
![fork_result](/img/git-helper/noodGuideToGit/fork_result.png)

### 克隆代码到本地

1. 进入自己的仓库后,点击绿色的 `Code` 按钮,获取本仓库的 SSH 链接。

**注意**:使用 SSH 链接需要先在本地主机上和自己的Github账户上,部署 SSH key 免密登入。该步骤可参考网络教程或官方教程 [Connecting to GitHub with SSH](https://docs.github.com/en/authentication/connecting-to-github-with-ssh) 完成。

![clone_local](../../../img/git-helper/noodGuideToGit/clone_local.png)
![clone_local](/img/git-helper/noodGuideToGit/clone_local.png)

2. 在你打算存放该代码仓库的目录下,打开 `Git Bash` 终端,输入命令,即可在本地获取到对应代码仓库,并自动与远程仓库关联。
1. 在你打算存放该代码仓库的目录下,打开 `Git Bash` 终端,输入命令,即可在本地获取到对应代码仓库,并自动与远程仓库关联。
```
git clone [email protected]:<github_account>/<repository_name.git>
e.g. git clone [email protected]:the-fall-moon/evalcsu.git
```

![clone_code](../../../img/git-helper/noodGuideToGit/clone_code.png)
![clone_code](/img/git-helper/noodGuideToGit/clone_code.png)

### 创建自己的分支

Expand Down Expand Up @@ -143,25 +140,25 @@ git remote add upstream_name [email protected]:github_account/<repository_name.git>
e.g. git remote add upstream [email protected]:jacob953/evalcsu.git
```

![remote_add](./../../../img/git-helper/noodGuideToGit/remote_add.png)
![remote_add](/img/git-helper/noodGuideToGit/remote_add.png)

2. 去上游仓库拉取一次你所需保持跟踪的分支 upstream/main 。
1. 去上游仓库拉取一次你所需保持跟踪的分支 upstream/main 。
```
git fetch <upstream_name> <branch_name>
e.g. git fetch upstream main
```

![fetch_upstream](./../../../img/git-helper/noodGuideToGit/fetch_upstream.png)
![fetch_upstream](/img/git-helper/noodGuideToGit/fetch_upstream.png)

3. 将 upstream/main 设置为你**当前分支**所要跟踪的远程仓库分支。
1. 将 upstream/main 设置为你**当前分支**所要跟踪的远程仓库分支。
```
git branch -u <upstream_name>/<branch_name>
e.g. git branch -u upstream/main
```

![branch_set](./../../../img/git-helper/noodGuideToGit/branch_set.png)
![branch_set](/img/git-helper/noodGuideToGit/branch_set.png)

4.**设置过的分支**使用 git pull 命令简化拉取最新版本的操作。
1.**设置过的分支**使用 git pull 命令简化拉取最新版本的操作。

### 提交修改到远程仓库

Expand All @@ -177,9 +174,9 @@ eg: git push origin

1. 打开 GitHub,从个人仓库中选择 `New pull request` 按钮

![github_button](./../../../img/git-helper/noodGuideToGit/github_button.png)
![github_button](/img/git-helper/noodGuideToGit/github_button.png)

2. 选取本仓库的主分支与你修改过的分支作为比较对象,依照以下方式描述你的修改:
1. 选取本仓库的主分支与你修改过的分支作为比较对象,依照以下方式描述你的修改:
1.**标题栏**中按照 `<type>[optional scope]: <description>` 的方式命名标题,要求简洁明了,不可缺失
2.**Related Issue** 中链接到相关 Issue,不可缺失
3.**Propose changes** 中简述你的改动,不可缺失
Expand All @@ -188,9 +185,9 @@ eg: git push origin
6.**Screenshoot** 中贴上对应截图
7.**Reviewers** 处添加数个检查者

![github_pull](../../../img/git-helper/noodGuideToGit/github_pull.png)
![github_pull](/img/git-helper/noodGuideToGit/github_pull.png)

3. 点击 `Create pull request` 按钮创建你的合并请求
1. 点击 `Create pull request` 按钮创建你的合并请求

## 二、部分常用的 git 命令补充
### 初始化
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 285279c

Please sign in to comment.