blob: 3fc732ee2467df8a59a5c62e13b3ccaca14c2fc8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
|
# 贡献准则
## 底线
1. 内容不得违反中华人民共和国法律法规。
2. 所有引用内容(包括但不限于链接、图片)必须为中国大陆可正常访问的、有效存在的、未过时的资源。
## 内容
1. 项目尽量遵循J4W原则,即Just for Work,指文档应在必须的,无法避免的,影响日常的且新手需要的,可以理解的方面撰写。对于能够显著改善使用体验的内容,我们欢迎贡献。
2. 对于常见问题,不得纳入冷门、小众的内容(如某机型特定驱动修复、CLOVER引导配置等),一切问题必须是常见的,广泛的,可复现的。
3. 对于教程,不得出现不常见的或不相关的内容(如C++编译、Synapse搭建方法)。
4. 对于概念,不得过度涉及系统底层(如PAM、管道)。非必要尽量少地添加新概念。
5. 尽可能采用简单的语言阐释,如类比等。
6. 仅有分离困难或相关性极大的内容允许被合并(如BIOS/UEFI允许,Deepin/统信UOS、Enterprise Linux三巨头不允许)。
7. 不得出现个人文笔色彩强烈的内容。
8. 除笔误、拼写错误相关外,所有提交必须经过PR与审查流程,由Reviewers审查。
9. 允许AI生成内容,但必须经过人工实机核查。
## 格式
1. 已经有Template的栏目请严格遵照模板,无模板栏目请参考先前已有文章文体格式。
2. 对于包名、指令名、单行代码请使用行内代码;对于多行代码,请使用块级代码。已采用块级代码的多行代码无须修改。
3. 所有内链禁止使用硬编码,请链接到相应.md文件。
4. 合理使用Admonitions([MkDocs](https://squidfunk.github.io/mkdocs-material/reference/admonitions/)或[VitePress](https://vitepress-theme-default-plus.lando.dev/markdown/admonitions.html))。
5. 提交前请务必检查内容能否正常渲染与展示。
|