From ad97ccf37db0ed0f55bac1b7a5acfd9417e421f3 Mon Sep 17 00:00:00 2001 From: MingqiHuang Date: Wed, 29 Aug 2018 14:35:58 +0800 Subject: [PATCH] Update pull_request_template.md --- .github/pull_request_template.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 952541db..88bda58f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,10 @@ 首先，十分感谢你花时间来给 OI Wiki 开一个 Pull Request，下面是一些你可能需要知道的信息： - 请在 commit 的时候写比较有意义的 commit message - - 请给 PR 起比较有意义的标题。 +- 请在 PR 之前检查一下您的 PR 是否存在以下常见问题： + * [ ] 您的 MD 代码的书写格式，包括但不限于 **中文与英文之间、中文与阿拉伯数字、中文与 LaTeX 公式之间要有一个半角空格**，特别地，在中文全角符号与英文、阿拉伯数字、LaTeX 公式之间，**不需要**半角空格。 + * [ ] 对于 LaTeX 公式，请注意常见的问题，**一定要**使用 `$\log$`、`$\min$`、`$\max$`、`$\gcd$` 等，而非 `$log$`、`$min$`、`$max$`、`$gcd$`。对于最小公倍数，请使用 `$\operatorname{lcm}$` 而非 `$lcm$`。 + * [ ] 所有公式中的希腊字母等特殊符号，请不要使用输入法的插入特殊符号功能，而应该使用对应的 LaTeX 公式符号。如 `ϕ` 应该使用 `$\phi$` 或 `\varphi`。 + * [ ] 公式与正文之间要有一行空行。 + * [ ] 对于目录中存在公式的情况，请使用 HTML 代码而非直接插入公式以避免双倍公式的问题，请参考[避免 ToC 中双倍公式的写法](https://github.com/24OI/OI-wiki/blame/master/docs/string/sam.md#L82)。 -- 2.11.0