From e7bd8e253be914879ea2e02ee5773e64ba2a2e40 Mon Sep 17 00:00:00 2001 From: ruzell22 Date: Thu, 12 Oct 2023 15:02:25 +0800 Subject: [PATCH] docs: add Pull Request Template Checkbox is updated so it will reflect as expected. fixes: #91 related to: #2708 Signed-off-by: ruzell22 --- PULL_REQUEST_TEMPLATE.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 0c953a9ddf2..fd34c317ad0 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,11 @@ **Pull Request Requirements** -[ ] Rebased onto `upstream/main` branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why. -[ ] Have git sign off at the end of commit message to avoid being marked red. You can add `-s` flag when using `git commit` command. You may refer to this [link](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) for more information. -[ ] Follow the Commit Linting specification. You may refer to this [link](https://www.conventionalcommits.org/en/v1.0.0-beta.4/#specification) for more information. +`- [ ] Rebased onto upstream/main branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.` +`- [ ] Have git sign off at the end of commit message to avoid being marked red. You can add `-s` flag when using `git commit` command. You may refer to this [link](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) for more information.` +`- [ ] Follow the Commit Linting specification. You may refer to this [link](https://www.conventionalcommits.org/en/v1.0.0-beta.4/#specification) for more information.` **Character Limit** -[ ] Pull Request Title and Commit Subject must not exceed 72 characters (including spaces and special characters). -[ ] Commit Message per line must not exceed 80 characters (including spaces and special characters). +`- [ ] Pull Request Title and Commit Subject must not exceed 72 characters (including spaces and special characters).` +`- [ ] Commit Message per line must not exceed 80 characters (including spaces and special characters).` **A Must Read for Beginners** For rebasing and squashing, here's a [must read guide](https://github.com/servo/servo/wiki/Beginner's-guide-to-rebasing-and-squashing) for beginners. \ No newline at end of file