Skip to content

Commit 14b4ed3

Browse files
committed
add pr and doc
1 parent fa783ca commit 14b4ed3

File tree

6 files changed

+220
-0
lines changed

6 files changed

+220
-0
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: ✒️ Documentation
3+
weight: 30
4+
---
5+
6+
{{< toc >}}
7+
8+
Qob includes a comprehensive user guide. Please try to extend it accordingly while
9+
you implement new features.
10+
11+
The documentation is written in [Markdown](https://gohugo.io/), using [Hugo]() and GitHub Pages.
12+
The former is the static site generator, and the latter is the static web pages hosting service
13+
from GitHub.
14+
15+
{{< hint info >}}
16+
💡 You can find all our documentation under the **docs/content/** folder.
17+
{{< /hint >}}
18+
19+
### 🚩 Prerequisites
20+
21+
To make changes to documentation, you should have:
22+
23+
* [hugo](https://gohugo.io/getting-started/quick-start/#step-1-install-hugo)
24+
executable; the static site generator.
25+
26+
### 📐 Setup
27+
28+
To set up the website locally, you need to first install the theme:
29+
30+
```sh
31+
# Clone the repository with submodules...
32+
git clone https://github.com/cl-qob/cli --recurse-submodules
33+
34+
# Navgiate to `docs/theme/geekdoc` folder
35+
cd ./docs/theme/geekdoc/
36+
37+
# Build the themes
38+
npm install && npm run build
39+
```
40+
41+
Then run the `hugo` command:
42+
43+
```sh
44+
# Navigate back to `docs` folder
45+
cd ./docs/
46+
47+
# Run hugo server locally
48+
hugo server
49+
```
50+
51+
And that's it! Now you can open the browser with the URL `localhost:1313`. 🎉
52+
53+
{{< hint info >}}
54+
💡 You can specify **-D** option if you consider writing a draft.
55+
{{< /hint >}}
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: ✒️ 文檔
3+
weight: 30
4+
---
5+
6+
{{< toc >}}
7+
8+
Qob 包含全面的用戶指南。 請嘗試相應地擴展它您實施新功能。
9+
10+
該文檔使用 [Hugo]() 和 GitHub Pages 以 [Markdown](https://gohugo.io/) 編寫。
11+
前者是靜態站點生成器,後者是靜態網頁託管服務來自 GitHub。
12+
13+
{{< hint info >}}
14+
💡 您可以在 **docs/content/** 文件夾下找到我們所有的文檔。
15+
{{< /hint >}}
16+
17+
### 🚩 必備條件
18+
19+
要更改文檔,您應該:
20+
21+
- [hugo](https://gohugo.io/getting-started/quick-start/#step-1-install-hugo)
22+
可執行; 靜態站點生成器。
23+
24+
### 📐 設置
25+
26+
要在本地設置網站,您需要先安裝主題:
27+
28+
```sh
29+
# 克隆代碼庫和子模塊一起...
30+
git clone https://github.com/cl-qob/cli --recurse-submodules
31+
32+
# 導航到 `docs/theme/geekdoc` 文件夾
33+
cd ./docs/theme/geekdoc/
34+
35+
# 構建主題
36+
npm install && npm run build
37+
```
38+
39+
然後運行 `hugo` 命令:
40+
41+
```sh
42+
# 導航回 `docs` 文件夾
43+
cd ./docs/
44+
45+
# 在本地運行 hugo 服務器
46+
hugo server
47+
```
48+
49+
就是這樣! 現在您可以在瀏覽器裡面打開 `localhost:1313`。 🎉
50+
51+
{{< hint info >}}
52+
💡 如果你考慮寫草稿,你可以指定 **-D** 選項。
53+
{{< /hint >}}
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: ❓ How to Contribute
3+
weight: 0
4+
---
5+
6+
{{< toc >}}
7+
8+
## ⚜️ Code of Conduct
9+
10+
We have adopted the [Contributor Covenant](https://www.contributor-covenant.org/)
11+
as its Code of Conduct, and we expect project participants to adhere to it.
12+
Please read the full text so that you can understand what actions will and will
13+
not be tolerated.
14+
15+
## 🪑 Open Development
16+
17+
All work on Qob happens directly on [GitHub](https://github.com/cl-qob/cli).
18+
Both core team members and external contributors send pull requests which go
19+
through the same review process.
20+
21+
## 📌 Semantic Versioning
22+
23+
Qob follows [semantic versioning](https://semver.org/). We release patch versions
24+
for critical bugfixes, minor versions for new features or non-essential changes,
25+
and major versions for any breaking changes. When we make breaking changes, we
26+
also introduce deprecation warnings in a minor version so that our users learn
27+
about the upcoming changes and migrate their code in advance.
28+
29+
Every significant change is documented in the [changelog file](https://github.com/cl-qob/cli/blob/master/CHANGELOG.md).
30+
31+
## 💡 Branch Organization
32+
33+
Submit all changes directly to the `master` branch. We don’t use separate branches
34+
for development or for upcoming releases. We do our best to keep `master` in good shape,
35+
with all tests passing.
36+
37+
Code that lands in `master` must be compatible with the latest stable release. It may
38+
contain additional features, but no breaking changes. We should be able to release
39+
a new minor version from the tip of `master` at any time.
40+
41+
## 📂 State of the project
42+
43+
The project's bare-bones are pretty much done, we are currently looking for
44+
contributors to give us feedback and improve our TUI/UX for this tool!
45+
46+
We are also looking for advice to add more. Common Lisper often use commands
47+
and options, so these features are prepared by default!
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: ❓ 如何貢獻
3+
weight: 0
4+
---
5+
6+
{{< toc >}}
7+
8+
## ⚜️ 行為守則
9+
10+
我們採用了[貢獻者公約](https://www.contributor-covenant.org/)
11+
作為其行為準則,我們希望項目參與者遵守它。請閱讀全文,以便您了解將要執行的操作不容忍。
12+
13+
## 🪑 開放發展
14+
15+
Qob 上的所有工作都直接在 [GitHub](https://github.com/cl-qob/cli) 上進行。
16+
核心團隊成員和外部貢獻者都發送 PR 通過相同的審查程序。
17+
18+
## 📌 語義版本控制
19+
20+
Qob 遵循 [語義版本控制](https://semver.org/)。 我們發布補丁版本對於關鍵錯誤修復、
21+
新功能的次要版本或非必要的更改,以及任何重大更改的主要版本。 當我們進行重大更改時,我們
22+
還在次要版本中引入棄用警告,以便我們的用戶了解關於即將發生的變化並提前遷移他們的代碼。
23+
24+
[變更日誌文件](https://github.com/cl-qob/cli/blob/master/CHANGELOG.md) 中記錄了每個重大變更。
25+
26+
## 💡 分支機構
27+
28+
將所有更改直接提交到 `master` 分支。 我們不使用單獨的分支機構用於開發或即將發布的版本。
29+
我們盡最大努力讓“主人”保持良好狀態,通過所有測試。
30+
31+
落在 master 中的代碼必須與最新的穩定版本兼容。 它可能包含附加功能,但沒有重大更改。
32+
我們應該能夠釋放隨時從 `master` 的提示中獲取一個新的次要版本。
33+
34+
## 📂 項目狀況
35+
36+
該項目的基本框架已經完成,我們目前正在尋找貢獻者向我們提供反饋並改進此工具的 TUI/UX!
37+
38+
我們也在尋求建議以增加更多。 Common Lisper 常用命令和選項,所以這些功能是默認准備的!
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: 📭 Pull Request
3+
weight: 40
4+
---
5+
6+
If all tests have passed, and the Qob can operate normally with updated
7+
documentation (if any), please send us a [pull request](https://github.com/cl-qob/cli/pulls)
8+
with your changes. 🎊
9+
10+
# 🧪 Tests Explained
11+
12+
This has moved to the repository [README.md](https://github.com/cl-qob/cli/blob/master/README.md) file.
13+
14+
Please visit https://github.com/cl-qob/cli#-testing.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: 📭 提交 PR
3+
weight: 40
4+
---
5+
6+
如果所有測試都通過,Qob 可以在更新後正常運行文檔(如果有),請向我們發送 [pull request](https://github.com/cl-qob/cli/pulls)
7+
隨著你的改變。 🎊
8+
9+
# 🧪 測試說明
10+
11+
這已移至存儲庫 [README.md](https://github.com/cl-qob/cli/blob/master/README.md) 文件。
12+
13+
請訪問 https://github.com/cl-qob/cli#-testing。

0 commit comments

Comments
 (0)