Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions htc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
**Web3Club**组织成员 和 **Web3 Wiki** 项目组全体成员 随时欢迎您为本项目贡献页面。

这篇文章将主要叙述参与 **Web3 Wiki** 编写的写作过程。请您在撰稿或者修正 Wiki 页面以前,仔细阅读以下内容,以帮助您完成更高质量的内容。

## 参与协作

在开始编写一段内容之前,请查阅 [Issues](https://github.com/Web3-Club/Web3wiki-Website/issues),确认没有别人在做相同的工作之后,开个 新 issue 记录待编写的内容。

## 在 GitHub 上编辑 本Wiki

若您想 参与 Web3 Wiki 的编写,您需要一个 GitHub 账号(可以前往 [GitHub注册](https://github.com/signup) 页面注册)。

### 使用 Git 在本地进行编辑

虽然大多数情况下您可以直接在 GitHub 上进行编辑,但对于一些较为特殊的情况(如需要使用 GPG 签名),我们更推荐使用 Git 在本地进行编辑。

大致流程如下:

1. 将主仓库 Fork 到自己的仓库中;
2. 将 Fork 后的分支仓库克隆(clone)到本地;
3. 在本地进行修改后提交(commit)这些更改;
4. 将这些更改推送(push)到你克隆的分支仓库;
5. 提交 Pull Request 至主仓库。


#### 向 Pull Request 追加更改

在 clone 下来的本地分支仓库中继续进行修改,并提交(commit)以及推送(push)这些更改即可。你的更改会被自动追加在 Pull Request 中。

#### Commit 信息格式规范

对于提交时需要填写的 commit 信息,请遵守以下几点基本要求:

1. commit 摘要请简要描述这一次 commit 改动的内容。注意 commit 摘要的长度不要超过 50 字符,超出的部分会自动置于正文中。
2. 如果需要进一步描述本次 commit 内容,请在正文中详细说明。

对于 commit 摘要,推荐按照如下格式书写:

```text
<修改类型>(<文件名>): <修改的内容>
```

修改类型分为如下几类:

- `feat`:用于添加内容的情况。
- `fix`:用于修正现有内容错误的情况。
- `refactor`:用于对一个页面进行重构(较大规模的更改)的情况。
- `revert`:用于回退之前更改的情况。