Skip to content

Commit 9c024bd

Browse files
authored
chore: added CONTRIBUTING.md (#27)
* Create CONTRIBUTING.md * fix: lint
1 parent 171a8e1 commit 9c024bd

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

CONTRIBUTING.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Missing Semester 写作规范指南
2+
3+
> [!important]
4+
>
5+
> Work in progress.
6+
7+
## 标点
8+
9+
优先使用**全角**标点符号,**除非**
10+
11+
- `/`
12+
- 在以英文作为主导语言的上下文中,例如:
13+
- 英文引文
14+
- 多个英文单词的并列,导致全角标点在其间并不合适,e.g. `ls`, `cd`, `cat`
15+
- 对英文缩写进行解释,e.g. CLI (Command Line Interface, 命令行界面)
16+
- 半角引号(有待商榷,Windows 下全角引号占一个字符宽,前后无需加空格,而 macOS 下将全角引号压缩至半角宽度,前后需要加上空格确保可读性)
17+
- 引文原文如此
18+
- 其他全角字符看上去怪异的情况
19+
20+
不要在列表后插入分号或其他字符,段落尾部使用句号结束段落。
21+
22+
## 空格
23+
24+
- 在全角字符与半角字符间(取决于渲染后效果,而非 Markdown 源代码)插入空格,**除非**
25+
- 全角字符为全角标点
26+
- 引文原文如此
27+
- 在半角标点后插入空格,**除非**
28+
- `(`
29+
- 在恰当的呼吸处插入空格
30+
-`/` 前后插入空格(有待商榷)
31+
- 在行内代码块前后插入空格(有待商榷)
32+
33+
> [!important]
34+
>
35+
> 将空格置于文本块外,而不是块内,例如:
36+
>
37+
> - 正确的 [example](/#) like this
38+
> - 错误的[example](/#)like this
39+
40+
## 拼写
41+
42+
- 正确使用大小写,对齐官方使用的样式,重灾区例如:
43+
- macOS(旧作 OS X,MacOS)
44+
- Windows
45+
- Linux
46+
- VMware Workstation
47+
- 使用 `macOS` 而非 `mac`,除非特指硬件
48+
49+
## 链接
50+
51+
链接应当有明确的链接文本,避免使用 [官网](/#)[网址](/#) 这样的文本。一般的,使用页面标题或其适当的缩略形式作为链接文本,对于 Github 仓库链接,使用 [Github - owner/repo](/#) 的短格式。
52+
53+
> [!important]
54+
>
55+
> 方括号和圆括号不要写反!!!
56+
57+
## 引用(有待商榷)
58+
59+
- 由于全角引号跨平台显示的不一致性及在全角环境中使用半角直引号的怪异效果,优先使用 `行内代码块` 表示短语或句子的原文引用
60+
- 正确使用 Blockquote 引用段落
61+
62+
## 代码块
63+
64+
代码块应当有明确的语言标注以获得最佳的着色效果,如非必要,不使用 plain 类型。如果需要对语句作出解释,使用注释,而不是鲁莽地将语言类型设置为 plain。
65+
66+
## 分段
67+
68+
在合适处分段以减小阅读压力,避免产生过长的段落。

0 commit comments

Comments
 (0)