aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFangcatChina <f20091219@outlook.com>2026-08-15 06:54:34 +0000
committerFangcatChina <f20091219@outlook.com>2026-08-15 06:54:34 +0000
commit4549c7b0f950e924d3fd6c43fd6e6321f8f234d5 (patch)
tree97daa128f3e52c8c47fee6eb5171e2271904c477
parentdocs: advanced (diff)
feat: code of conduct
-rw-r--r--CODE_OF_CONDUCT.md26
-rw-r--r--CONTRIBUTING.md64
-rw-r--r--README.md4
3 files changed, 37 insertions, 57 deletions
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..b73885c
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,26 @@
+# 贡献准则
+
+## 底线
+
+1. 内容不得违反中华人民共和国法律法规。
+2. 所有引用内容(包括但不限于链接、图片)必须为中国大陆可正常访问的、有效存在的、未过时的资源。
+
+## 内容
+
+1. 对于常见问题,不得纳入冷门、小众的内容(如某机型特定驱动修复、CLOVER引导配置等),一切问题必须是常见的,广泛的,可复现的。
+2. 对于教程,不得出现不常见的或不相关的内容(如C++编译、Synapse搭建方法)。
+3. 对于概念,不得过度涉及系统底层(如PAM、管道)。
+4. 尽可能采用简单的语言阐释,如类比等。
+5. 仅有分离困难或相关性极大的内容允许被合并(如BIOS/UEFI允许,Deepin/统信UOS、Enterprise Linux三巨头不允许)。
+6. 不得出现个人文笔色彩强烈的内容。
+7. 除笔误、拼写错误相关外,所有提交必须经过PR与审查流程,由Reviewers审查。
+8. 允许AI生成内容,但必须经过人工实机核查。
+
+## 格式
+
+1. 已经有Template的栏目请严格遵照模板,无模板栏目请参考先前已有文章文体格式。
+2. 对于包名、指令名、单行代码请使用行内代码;对于多行代码,请使用块级代码。
+3. 所有内链禁止使用硬编码,请链接到相应.md文件。
+4. 合理使用[Admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/)。
+5. 提交前请务必检查内容能否正常渲染与展示。
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 74c8ce5..d4053a9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,35 +1,6 @@
-贡献者,你好!
+# 贡献指南
-感谢您对本项目做出的支持!以下是一些注意事项。
-
-## 在哪里贡献?
-
-您可以通过提Issues,或者发起PR (Pull Request) 的方式来贡献。在贡献时,我们建议您将负责人设置为LinuxCabin的一位管理成员以更快处理您的请求。
-
-下面是一个可供参考的模板:
-
-```
-我希望增加内容的标题: The Title
-这个内容应被放置/追加在:Chapter-Another Chapter章节
-
-章节内容:
-
-xxxxxx
-
-```
-
-若您的内容被退回,建议您仔细阅读退回原因。如果经过修改没有问题,我们允许您再次提交。
-
-### 我们不建议您贡献的内容
-
-- 与Linux无关的内容
-- 专业性过高的内容
-- 偏颇/太过不常见的内容(如果值得商讨您也可以贡献)
-- 由AIGC生成的内容(经由人工审核且确认无误的情况除外)
-
-## PR贡献的工作流?
-
-### 安装必要依赖
+## 安装必要依赖
请确保您的电脑已经安装了最新版的Python,并被添加到PATH中。
@@ -39,21 +10,22 @@ xxxxxx
pip install -r requirements.txt
```
-(注:为防止python3安装的依赖污染系统环境导致系统不稳定,建议[创建venv虚拟环境](#venv虚拟环境))
-
### venv虚拟环境
-#### 如果您直接使用python
+为防止Python 3安装的依赖污染系统环境导致系统不稳定,建议您创建venv虚拟环境。
+
+#### 直接使用Python
+
```
python -m venv .venv
-source .venv/bin/active
+source .venv/bin/activate
pip install -r requirements.txt
```
#### uv
```
uv venv
-source .venv/bin/active
+source .venv/bin/activate
uv pip install -r requirements.txt
```
@@ -69,22 +41,4 @@ uv pip install -r requirements.txt
mkdocs serve
```
-> 或者你可以直接在 `pending` 目录下新建一个目录,然后存放你的文档,管理员会将它放到正确的地方(如果审核通过的话)
-
-## 贡献时要符合什么规定?
-
-### 总体
-
-1. 所有内容**必须符合中华人民共和国法律**,不得出现涉政、色情、赌毒等内容。
-2. 部分内容需按照templates下的**模板**进行填写,允许在下方追加内容。
-3. 媒体资源建议引用**中国大陆用户能够正常访问**的资源。
-4. 我们建议引用链接为**简体中文官方内容**。
-5. 我们建议所有内容用尽可能简单的语言进行阐释。
-
-### 发行版
-
-1. 请不要将多个发行版合并到一篇文章中。
-2. 衍生发行版不应被置于父发行版的“风味”部分,而应单开一页。
-3. **请确保镜像源以及换源教程地址存在。**
-
-再次感谢您的理解!
+如果您的内容难以分类,你可以在 `pending` 目录下新建一个目录,然后存放你的文档,管理员会将它放到正确的地方。
diff --git a/README.md b/README.md
index b0444ef..4247ea4 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@
## 我们想要做什么?
-众所周知,当前中文互联网Linux教程纷繁复杂,并且大多不适合新手入门,因而,我们希望有一个教程,能够尽可能地涵盖更多发行版与更多新手的常见问题,而不过度涉及系统底层。
+众所周知,当前中文互联网Linux教程纷繁复杂,并且大多不适合新手入门与学习。因而,我们希望有一个教程,能够尽可能地涵盖更多发行版与更多新手的教程与常见问题,而不过度涉及系统底层。
## 我们面向谁?
@@ -27,7 +27,7 @@ LinuxCabin是一个志愿者组织,本教程由对Linux抱有热情的用户æ’
我们广泛欢迎各位志愿者贡献文档。
-贡献前必看:[CONTRIBUTING.md](CONTRIBUTING.md)
+贡献前必看:[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) 与 [CONTRIBUTING.md](CONTRIBUTING.md)
## 项目架构