Update contribute.md
62
README.md
@ -1 +1,63 @@
|
|||||||
# 19yuke2-vue
|
# 19yuke2-vue
|
||||||
|
|
||||||
|
合肥市南园学校19预科2班纪念站点项目
|
||||||
|
|
||||||
|
## 项目结构
|
||||||
|
```
|
||||||
|
19yuke2-vue
|
||||||
|
├─.dockerignore
|
||||||
|
├─.editorconfig
|
||||||
|
├─.eslintrc
|
||||||
|
├─.gitignore
|
||||||
|
├─.npmrc
|
||||||
|
├─cypress.config.ts
|
||||||
|
├─Dockerfile
|
||||||
|
├─index.html
|
||||||
|
├─LICENSE
|
||||||
|
├─package.json
|
||||||
|
├─pnpm-lock.yaml
|
||||||
|
├─README.md
|
||||||
|
├─tsconfig.json
|
||||||
|
├─unocss.config.ts
|
||||||
|
├─vite.config.ts
|
||||||
|
├─test
|
||||||
|
├─src
|
||||||
|
| ├─App.vue
|
||||||
|
| ├─auto-imports.d.ts
|
||||||
|
| ├─components.d.ts
|
||||||
|
| ├─main.ts
|
||||||
|
| ├─shims.d.ts
|
||||||
|
| ├─types.ts
|
||||||
|
| ├─styles
|
||||||
|
| | ├─main.css
|
||||||
|
| | └markdown.css
|
||||||
|
| ├─posts
|
||||||
|
| | └contribute.md
|
||||||
|
| ├─plugins
|
||||||
|
| | └vuetify.ts
|
||||||
|
| ├─pages
|
||||||
|
| | ├─about.md
|
||||||
|
| | └index.md
|
||||||
|
| ├─modules
|
||||||
|
| | ├─i18n.ts
|
||||||
|
| | ├─nprogress.ts
|
||||||
|
| | └pwa.ts
|
||||||
|
| ├─layouts
|
||||||
|
| | ├─404.vue
|
||||||
|
| | └default.vue
|
||||||
|
| ├─composables
|
||||||
|
| | └dark.ts
|
||||||
|
| ├─components
|
||||||
|
| | ├─Footer.vue
|
||||||
|
| | └Nav.vue
|
||||||
|
├─public
|
||||||
|
├─locales
|
||||||
|
| ├─en.yml
|
||||||
|
| └zh-CN.yml
|
||||||
|
├─dist
|
||||||
|
├─.vscode
|
||||||
|
| └settings.json
|
||||||
|
├─.github
|
||||||
|
| ├─workflows
|
||||||
|
| | └ci.yml
|
||||||
|
```
|
Before Width: | Height: | Size: 37 KiB |
BIN
public/images/contribute_0.png
Normal file
After Width: | Height: | Size: 39 KiB |
BIN
public/images/contribute_1.png
Normal file
After Width: | Height: | Size: 25 KiB |
BIN
public/images/contribute_10.png
Normal file
After Width: | Height: | Size: 32 KiB |
BIN
public/images/contribute_11.png
Normal file
After Width: | Height: | Size: 44 KiB |
BIN
public/images/contribute_12.png
Normal file
After Width: | Height: | Size: 56 KiB |
BIN
public/images/contribute_13.png
Normal file
After Width: | Height: | Size: 38 KiB |
BIN
public/images/contribute_14.png
Normal file
After Width: | Height: | Size: 49 KiB |
BIN
public/images/contribute_15.png
Normal file
After Width: | Height: | Size: 31 KiB |
BIN
public/images/contribute_16.png
Normal file
After Width: | Height: | Size: 49 KiB |
BIN
public/images/contribute_17.png
Normal file
After Width: | Height: | Size: 45 KiB |
BIN
public/images/contribute_18.png
Normal file
After Width: | Height: | Size: 57 KiB |
BIN
public/images/contribute_19.png
Normal file
After Width: | Height: | Size: 44 KiB |
BIN
public/images/contribute_2.png
Normal file
After Width: | Height: | Size: 25 KiB |
BIN
public/images/contribute_20.png
Normal file
After Width: | Height: | Size: 49 KiB |
BIN
public/images/contribute_21.png
Normal file
After Width: | Height: | Size: 38 KiB |
BIN
public/images/contribute_22.png
Normal file
After Width: | Height: | Size: 26 KiB |
BIN
public/images/contribute_23.png
Normal file
After Width: | Height: | Size: 56 KiB |
BIN
public/images/contribute_3.png
Normal file
After Width: | Height: | Size: 57 KiB |
BIN
public/images/contribute_4.png
Normal file
After Width: | Height: | Size: 30 KiB |
BIN
public/images/contribute_5.png
Normal file
After Width: | Height: | Size: 57 KiB |
BIN
public/images/contribute_6.png
Normal file
After Width: | Height: | Size: 48 KiB |
BIN
public/images/contribute_7.png
Normal file
After Width: | Height: | Size: 32 KiB |
BIN
public/images/contribute_8.png
Normal file
After Width: | Height: | Size: 31 KiB |
BIN
public/images/contribute_9.png
Normal file
After Width: | Height: | Size: 31 KiB |
@ -1,14 +1,141 @@
|
|||||||
# 贡献指南
|
# 贡献指南
|
||||||
|
|
||||||
我们十分欢迎来自同学们的贡献,您只需 4 个步骤即可完成对本站任意博文 (Post) 的更改。
|
本文介绍了向 [19yuke2-vue](https://git.thehrz.net/thehrz/19yuke2-vue) 创建 `合并请求` 的完整操作步骤。
|
||||||
|
|
||||||
## Step 1: 「贡献账号」
|
本文不对 Git 做过多介绍,若你想更多了解 Git,你可以自行学习它。但是对于想要编辑文章的同学们来说,学习以下步骤即可处理大部分情况。
|
||||||
|
|
||||||
### 注册
|
我们十分欢迎来自同学们的贡献,您只需 4 个步骤即可完成对本站任意文章 (Post) 的更改。
|
||||||
接下来一切的前提是: 你需要注册并登录一个 「贡献账号」 用于向本站点提交更改。
|
|
||||||
|
|
||||||
打开此网站: [Thehrz's Git Server](https://git.thehrz.net/)
|
## Step 1: 注册「贡献账号」
|
||||||
|
|
||||||
点击 `注册`
|
接下来一切的前提是: 你需要注册并登录一个 「贡献账号」,用于向本站点提交更改。
|
||||||
|
|
||||||
<img src="/contribute_0.png" />
|
打开此网站: [Thehrz's Git Server](https://git.thehrz.net/)。
|
||||||
|
|
||||||
|
![](/images/contribute_0.png)
|
||||||
|
|
||||||
|
点击 `注册`。
|
||||||
|
|
||||||
|
![](/images/contribute_1.png)
|
||||||
|
|
||||||
|
填写基本信息后点击 `注册账号`。
|
||||||
|
|
||||||
|
![](/images/contribute_2.png)
|
||||||
|
|
||||||
|
若成功注册账号,您将自动跳转到个人工作台,并提示 `帐户创建成功。`。至此账号注册完毕。
|
||||||
|
|
||||||
|
## Step 2: 派生 (Fork) 主仓库
|
||||||
|
|
||||||
|
打开此地址: [19yuke2-vue](https://git.thehrz.net/thehrz/19yuke2-vue)。
|
||||||
|
|
||||||
|
![](/images/contribute_3.png)
|
||||||
|
|
||||||
|
点击 `派生`。
|
||||||
|
|
||||||
|
![](/images/contribute_4.png)
|
||||||
|
|
||||||
|
点击`派生仓库`。
|
||||||
|
|
||||||
|
![](/images/contribute_5.png)
|
||||||
|
|
||||||
|
这样,您就获得了一个属于自己的`19yuke2-vue`仓库,接下来将指导您更改文件。
|
||||||
|
|
||||||
|
## Step 3: 更改文件并创建提交
|
||||||
|
|
||||||
|
变更是指对一个文件的**创建**、**修改**、**删除**等操作。下面我们将指导您在线变更文件。
|
||||||
|
|
||||||
|
> **请注意: 所有文章都放置在 [src/posts](https://git.thehrz.net/Example/19yuke2-vue/src/branch/main/src/posts) 下**
|
||||||
|
|
||||||
|
### 创建文件
|
||||||
|
|
||||||
|
转到 [src/posts](https://git.thehrz.net/Example/19yuke2-vue/src/branch/main/src/posts) 目录下。
|
||||||
|
|
||||||
|
![](/images/contribute_6.png)
|
||||||
|
|
||||||
|
点击 `添加文件 -> 新建文件`。
|
||||||
|
|
||||||
|
> 请注意: 应新建 `.md `文件,比如 `jwd.md` 就是一个合法的文件名。
|
||||||
|
|
||||||
|
![](/images/contribute_7.png)
|
||||||
|
|
||||||
|
添加一些内容,这里添加了 `jwd.md` 到 `src/post/teachers` 目录下。
|
||||||
|
|
||||||
|
完成后翻到页面最下方。
|
||||||
|
|
||||||
|
![](/images/contribute_8.png)
|
||||||
|
|
||||||
|
![](/images/contribute_9.png)
|
||||||
|
|
||||||
|
我们仅仅需要为我们的 `提交` 添加一个`提交名`即可完成提交,比如这里的提交名是 `Add jwd.md`
|
||||||
|
|
||||||
|
> 请注意: 在没有更改文件更改文件或没有提交名时,提交按钮将不可点击,我们无法提交。
|
||||||
|
|
||||||
|
![](/images/contribute_10.png)
|
||||||
|
|
||||||
|
点击 `提交变更` 即可完成提交。
|
||||||
|
|
||||||
|
![](/images/contribute_11.png)
|
||||||
|
|
||||||
|
![](/images/contribute_12.png)
|
||||||
|
|
||||||
|
我们发现提交已经生效。
|
||||||
|
|
||||||
|
### 修改文件
|
||||||
|
|
||||||
|
我们不难发现刚才的`创建文件`部分出现了一个错误。
|
||||||
|
|
||||||
|
![](/images/contribute_13.png)
|
||||||
|
|
||||||
|
我们应该创建 `src/posts/teachers/jwd.md` 而不是 `src/post/teachers/jwd.md`。
|
||||||
|
|
||||||
|
这时候我们就可以修改文件了。
|
||||||
|
|
||||||
|
![](/images/contribute_14.png)
|
||||||
|
|
||||||
|
点击`编辑文件`。
|
||||||
|
|
||||||
|
![](/images/contribute_15.png)
|
||||||
|
|
||||||
|
完成对文件的修改后还是向上文提到的那样提交即可。
|
||||||
|
|
||||||
|
### 删除文件
|
||||||
|
|
||||||
|
![](/images/contribute_16.png)
|
||||||
|
|
||||||
|
点击`删除文件`。
|
||||||
|
|
||||||
|
![](/images/contribute_17.png)
|
||||||
|
|
||||||
|
向上文提到的那样提交即可。
|
||||||
|
|
||||||
|
## Step 4: 创建合并请求
|
||||||
|
|
||||||
|
我们在 `Step 3: 更改文件并创建提交` 对文件进行了更改并创建。
|
||||||
|
|
||||||
|
创建 `合并提交` 的前提是你的仓库有提交。
|
||||||
|
|
||||||
|
下面开始创建 `合并请求`。
|
||||||
|
|
||||||
|
![](/images/contribute_18.png)
|
||||||
|
|
||||||
|
点击 `合并请求`。
|
||||||
|
|
||||||
|
![](/images/contribute_19.png)
|
||||||
|
|
||||||
|
点击 `创建合并请求`。
|
||||||
|
|
||||||
|
![](/images/contribute_20.png)
|
||||||
|
|
||||||
|
点击 `合并到` 选择为 `thehrz:main`。
|
||||||
|
|
||||||
|
![](/images/contribute_21.png)
|
||||||
|
|
||||||
|
确认无误后,点击 `创建合并请求`。
|
||||||
|
|
||||||
|
![](/images/contribute_22.png)
|
||||||
|
|
||||||
|
写一些描述后,点击 `创建合并请求`。
|
||||||
|
|
||||||
|
![](/images/contribute_23.png)
|
||||||
|
|
||||||
|
这样我们就成功创建了一个 `合并请求`。
|
||||||
|