mirror of
https://github.com/halo-dev/docs.git
synced 2025-10-25 04:06:26 +00:00
docs: update documentation for Halo 2.18 (#407)
Signed-off-by: Ryan Wang <i@ryanc.cc>
This commit is contained in:
Ryan Wang
28
versioned_docs/version-2.19/contribution/issue.md
Normal file
28
versioned_docs/version-2.19/contribution/issue.md
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: 问题反馈
|
||||
description: 问题反馈渠道及指南
|
||||
---
|
||||
|
||||
:::info
|
||||
如果您在使用过程中遇到了什么问题，您可以通过下面的方式反馈，但请尽量按照要求提出反馈。
|
||||
:::
|
||||
|
||||
## GitHub Issues
|
||||
|
||||
链接：[https://github.com/halo-dev/halo/issues](https://github.com/halo-dev/halo/issues)
|
||||
|
||||
如果你在使用过程中，遇到了一些 bug 或者需要添加某些新特性，请尽量在 GitHub Issues 进行反馈，这非常有助于我们跟踪解决此问题，您也可以很方便的接收到处理状态。
|
||||
|
||||
建议步骤：
|
||||
|
||||
1. 在 [Issues 列表](https://github.com/halo-dev/halo/issues) 搜索相关问题，看看是否有其他人已经提到了此问题。
|
||||
2. 如果当前还没有人遇到您类似的问题，那么请点击右上角的 `New issue` 按钮创建新的 issue。
|
||||
3. 选择正确的反馈类型。
|
||||
4. 请尽可能详细的按照模板填写内容。
|
||||
5. 点击 `Submit new issue` 提交 issue。
|
||||
|
||||
## Halo 官方社区
|
||||
|
||||
链接：[https://bbs.halo.run](https://bbs.halo.run)
|
||||
|
||||
此平台主要目的用于与其他 Halo 用户进行交流。但如果您对 GitHub 不是很熟悉或者没有账号，您也可以在此平台进行反馈。
|
||||
110
versioned_docs/version-2.19/contribution/pr.md
Normal file
110
versioned_docs/version-2.19/contribution/pr.md
Normal file
@@ -0,0 +1,110 @@
|
||||
---
|
||||
title: 代码贡献
|
||||
description: 代码贡献指南
|
||||
---
|
||||
|
||||
欢迎关注并有想法参与 Halo 的开发，以下是关于如何参与到 Halo 项目的指南，仅供参考。
|
||||
|
||||
## 发现 Issue
|
||||
|
||||
所有的代码尽可能都有依据（Issue），不是凭空产生。
|
||||
|
||||
### 寻找一个 Good First Issue
|
||||
|
||||
> 这个步骤非常适合首次贡献者。
|
||||
|
||||
在 [halo-dev](https://github.com/halo-dev) 和 [halo-sigs](https://github.com/halo-sigs) 组织下，有非常多的仓库。每个仓库下都有可能包含一些“首次贡献者”友好的 Issue，主要是为了给贡献者提供一个友好的体验。 该类 Issue
|
||||
一般会用 `good-first-issue` 标签标记。标签 `good-first-issue` 表示该 Issue 不需要对 Halo 有深入的理解也能够参与。
|
||||
|
||||
请点击：[good-first-issue](https://github.com/issues?q=org%3Ahalo-dev+is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+no%3Aassignee+)
|
||||
查看关于 Halo 的 Good First Issue。
|
||||
|
||||
### 认领 Issue
|
||||
|
||||
若对任何一个 Issue 感兴趣，请尝试在 Issue 进行回复，讨论解决 Issue 的思路。确定后可直接通过 `/assign` 或者 `/assign @GitHub 用户名` 认领这个
|
||||
Issue。这样可避免两位贡献者在同一个问题上花时间。
|
||||
|
||||
## 代码贡献步骤
|
||||
|
||||
1. Fork 此仓库
|
||||
|
||||
点击 Halo 仓库主页右上角的 `Fork` 按钮即可。
|
||||
|
||||
2. Clone 仓库到本地
|
||||
|
||||
```bash
|
||||
git clone https://github.com/{YOUR_USERNAME}/halo --recursive
|
||||
# 或者 git clone git@github.com:{YOUR_USERNAME}/halo.git --recursive
|
||||
```
|
||||
|
||||
3. 添加主仓库
|
||||
|
||||
添加主仓库方便未来同步主仓库最新的 commits 以及创建新的分支。
|
||||
|
||||
```bash
|
||||
git remote add upstream https://github.com/halo-dev/halo.git
|
||||
# 或者 git remote add upstream git@github.com:halo-dev/halo.git
|
||||
git fetch upstream main
|
||||
```
|
||||
|
||||
4. 创建新的开发分支
|
||||
|
||||
我们需要从主仓库的主分支创建一个新的开发分支。
|
||||
|
||||
```bash
|
||||
git checkout upstream/main
|
||||
git checkout -b {BRANCH_NAME}
|
||||
```
|
||||
|
||||
5. 提交代码
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -s -m "Fix a bug king"
|
||||
git push origin {BRANCH_NAME}
|
||||
```
|
||||
|
||||
6. 合并主分支
|
||||
|
||||
在提交 Pull Request 之前，尽量保证当前分支和主分支的代码尽可能同步，这时需要我们手动操作。示例：
|
||||
|
||||
```bash
|
||||
git fetch upstream/main
|
||||
git merge upstream/main
|
||||
git push origin {BRANCH_NAME}
|
||||
```
|
||||
|
||||
## Pull Request
|
||||
|
||||
进入此阶段说明已经完成了代码的编写，测试和自测，并且准备好接受 Code Review。
|
||||
|
||||
### 创建 Pull Request
|
||||
|
||||
回到自己的仓库页面，选择 `New pull request` 按钮，创建 `Pull request` 到原仓库的 `main` 分支。
|
||||
然后等待我们 Review 即可，如有 `Change Request`，再本地修改之后再次提交即可。
|
||||
|
||||
提交 Pull Request 的注意事项：
|
||||
|
||||
- 提交 Pull Request 请充分自测。
|
||||
- 每个 Pull Request 尽量只解决一个 Issue，特殊情况除外。
|
||||
- 应尽可能多的添加单元测试，其他测试（集成测试和 E2E 测试）可看情况添加。
|
||||
- 不论需要解决的 Issue 发生在哪个版本，提交 Pull Request 的时候，请将主仓库的主分支设置为 `main`。例如：即使某个 Bug 于 Halo 2.0.x 被发现，但是提交 Pull Request 仍只针对
|
||||
`main` 分支，等待 Pull Request 合并之后，我们会通过 `/cherrypick release-2.0` 或者 `/cherry-pick release-2.1` 指令将此 Pull Request
|
||||
的修改应用到 `release-2.0` 和 `release-2.1` 分支上。
|
||||
|
||||
### 更新 commits
|
||||
|
||||
Code Review 阶段可能需要 Pull Request 作者重新修改代码，请直接在当前分支 commit 并 push 即可，无需关闭并重新提交 Pull Request。示例：
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -s -m "Refactor some code according code review"
|
||||
git push origin bug/king
|
||||
```
|
||||
|
||||
同时，若已经进入 Code Review 阶段，请不要强制推送 commits 到当前分支。否则 Reviewers 需要从头开始 Code Review。
|
||||
|
||||
### 开发规范
|
||||
|
||||
请参考 [https://docs.halo.run/developer-guide/core/code-style](https://docs.halo.run/developer-guide/core/code-style)
|
||||
，请确保所有代码格式化之后再提交。
|
||||
26
versioned_docs/version-2.19/contribution/sponsor.md
Normal file
26
versioned_docs/version-2.19/contribution/sponsor.md
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
title: 赞助我们
|
||||
description: 如果 Halo 对你有帮助，不妨赞助我们
|
||||
---
|
||||
|
||||
## 为什么需要赞助
|
||||
|
||||
我们花费了大量的精力来维护这个软件，并且也提供了不少资金来维护服务器，域名等。因此我们需要赞助来节省部分开发成本。你的赞助不仅仅会被我们用来支付一些开发成本（比如服务器，OSS，域名等），还会让我们有更多的信心和精力投入到这个开源项目的开发中。从而让项目保持更加健康的成长以及迭代。
|
||||
|
||||
## 赞助形式
|
||||
|
||||
:::info
|
||||
你可以通过任何形式对我们赞助，不限于资金。
|
||||
:::
|
||||
|
||||
### 资金赞助
|
||||
|
||||
- 爱发电：[https://afdian.com/a/halo-dev](https://afdian.com/a/halo-dev)
|
||||
|
||||
### 通过我们的推广链接购买服务器
|
||||
|
||||
如果你当前还没有购买服务器，可以考虑通过以下链接购买，这会为我们带来一部分收益。
|
||||
|
||||
- 阿里云：[https://www.aliyun.com/daily-act/ecs/activity_selection?userCode=j57gyupo](https://www.aliyun.com/daily-act/ecs/activity_selection?userCode=j57gyupo)
|
||||
- 阿里云新人专享：[https://www.aliyun.com/minisite/goods?userCode=j57gyupo](https://www.aliyun.com/minisite/goods?userCode=j57gyupo)
|
||||
- 腾讯云：[https://curl.qcloud.com/9Ogon25Y](https://curl.qcloud.com/9Ogon25Y)
|
||||
Reference in New Issue
Block a user