aboutsummaryrefslogtreecommitdiff
path: root/CODE_OF_CONDUCT.md
diff options
context:
space:
mode:
Diffstat (limited to 'CODE_OF_CONDUCT.md')
-rw-r--r--CODE_OF_CONDUCT.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..5dd281d
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,27 @@
+# 贡献准则
+
+## 底线
+
+1. 内容不得违反中华人民共和国法律法规。
+2. 所有引用内容(包括但不限于链接、图片)必须为中国大陆可正常访问的、有效存在的、未过时的资源。
+
+## 内容
+
+1. 对于常见问题,不得纳入冷门、小众的内容(如某机型特定驱动修复、CLOVER引导配置等),一切问题必须是常见的,广泛的,可复现的。
+2. 对于教程,不得出现不常见的或不相关的内容(如C++编译、Synapse搭建方法)。
+3. 对于概念,不得过度涉及系统底层(如PAM、管道)。
+4. 尽可能采用简单的语言阐释,如类比等。
+5. 仅有分离困难或相关性极大的内容允许被合并(如BIOS/UEFI允许,Deepin/统信UOS、Enterprise Linux三巨头不允许)。
+6. 不得出现个人文笔色彩强烈的内容。
+7. 项目尽量遵循J4W原则,即Just4Work,指文档必须在必须的,无法避免的,影响日常的且新手需要的,可以理解的方面撰写。
+8. 除笔误、拼写错误相关外,所有提交必须经过PR与审查流程,由Reviewers审查。
+9. 允许AI生成内容,但必须经过人工实机核查。
+
+## 格式
+
+1. 已经有Template的栏目请严格遵照模板,无模板栏目请参考先前已有文章文体格式。
+2. 对于包名、指令名、单行代码请使用行内代码;对于多行代码,请使用块级代码。
+3. 所有内链禁止使用硬编码,请链接到相应.md文件。
+4. 合理使用[Admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/)。
+5. 提交前请务必检查内容能否正常渲染与展示。
+