aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorat2er <xb0515@outlook.com>2026-08-12 06:42:38 +0000
committerat2er <xb0515@outlook.com>2026-08-12 06:43:30 +0000
commit67d71ff982061430e409a5cb253251ea3283e2fd (patch)
tree85b809e8b258d4f9277cc68c0b8043cbe8cc71f4 /CONTRIBUTING.md
parentfeat: rolling_update concept (diff)
feat(common-command): more documents about 'man' and 'info'
Also add some documents about `python virtual environment` to the CONTRIBUTING.md.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4380585..74c8ce5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -29,6 +29,8 @@ xxxxxx
## PR贡献的工作流?
+### 安装必要依赖
+
请确保您的电脑已经安装了最新版的Python,并被添加到PATH中。
在clone仓库后,请您执行来安装必要的库:
@@ -37,7 +39,27 @@ xxxxxx
pip install -r requirements.txt
```
-(注:为防止python3安装的依赖污染系统环境导致系统不稳定,建议创建venv虚拟环境)
+(注:为防止python3安装的依赖污染系统环境导致系统不稳定,建议[创建venv虚拟环境](#venv虚拟环境))
+
+### venv虚拟环境
+
+#### 如果您直接使用python
+```
+python -m venv .venv
+source .venv/bin/active
+pip install -r requirements.txt
+```
+
+#### uv
+```
+uv venv
+source .venv/bin/active
+uv pip install -r requirements.txt
+```
+
+### 构建
+
+> 如果您使用[虚拟环境](#venv虚拟环境),请不要退出此环境
我们的文章全部位于/docs目录下。如果您添加了之前不存在的章节,请您修改`mkdocs.yml`下的`nav`(照葫芦画瓢就行)来使得您的内容显示在侧边栏导航。