From 6ae9462c7b7aa28e06fe9f05f146e42f717d0210 Mon Sep 17 00:00:00 2001 From: Tan Yuanhong Date: Sat, 11 Apr 2020 15:09:31 +0800 Subject: [PATCH 1/2] Update documentation --- docs/devGuide/maintainerGuide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/devGuide/maintainerGuide.md b/docs/devGuide/maintainerGuide.md index d711451e8c..29c9b4d419 100644 --- a/docs/devGuide/maintainerGuide.md +++ b/docs/devGuide/maintainerGuide.md @@ -28,6 +28,8 @@ `Add built-in support for light themes from bootswatch (#745)` b. For non-trivial PRs, ensure that there is a sensible commit message accompanied by it. **Rationale:** So that future developers have an idea of what is going on for this PR without having to go back to the GitHub website. + + c. Before confirming the merging do ensure that no other PRs are merged to master **after you drafted the merging commit's title and message**. Otherwise GitHub may glitch out and merge your PR without squashing. (Reference: [MarkBind#1160](https://github.com/MarkBind/markbind/pull/1160)) Please follow the [commit message convention](https://oss-generic.github.io/process/docs/FormatsAndConventions.html#commit-message). For example, for PR #745, the commit message is as follows: From 63b90e9c7c14cf0a4983de8cbf16c9ba6843b28f Mon Sep 17 00:00:00 2001 From: Tan Yuanhong Date: Tue, 14 Apr 2020 18:10:09 +0800 Subject: [PATCH 2/2] Update docs/devGuide/maintainerGuide.md Co-Authored-By: nbriannl --- docs/devGuide/maintainerGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/devGuide/maintainerGuide.md b/docs/devGuide/maintainerGuide.md index 29c9b4d419..5066df9757 100644 --- a/docs/devGuide/maintainerGuide.md +++ b/docs/devGuide/maintainerGuide.md @@ -29,7 +29,7 @@ b. For non-trivial PRs, ensure that there is a sensible commit message accompanied by it. **Rationale:** So that future developers have an idea of what is going on for this PR without having to go back to the GitHub website. - c. Before confirming the merging do ensure that no other PRs are merged to master **after you drafted the merging commit's title and message**. Otherwise GitHub may glitch out and merge your PR without squashing. (Reference: [MarkBind#1160](https://github.com/MarkBind/markbind/pull/1160)) + c. Before confirming the merge, do ensure that no other PRs have been merged to master **since the time you started drafting the merging commit's title and message**. Otherwise, you may face a glitch where GitHub merges your PR without squashing. (Reference: [MarkBind#1160](https://github.com/MarkBind/markbind/pull/1160)) Please follow the [commit message convention](https://oss-generic.github.io/process/docs/FormatsAndConventions.html#commit-message). For example, for PR #745, the commit message is as follows: