From cc5d2db0f75b7c7d11ebda5457ceee0fb090d2ca Mon Sep 17 00:00:00 2001 From: ruzell22 Date: Tue, 19 Sep 2023 13:32:36 +0800 Subject: [PATCH] fix(docs): add Pull Request Template fixes: #91 adds Pull Request Template on the root directory as guideline for contributors. Signed-off-by: ruzell22 --- PULL_REQUEST_TEMPLATE.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000000..fae928e40ef --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,25 @@ +## Pull Request Requirements + +Pull Requests must be rebased onto master and squashed into a single commit to +help maintainers review it more efficiently and to avoid spaghetti git commit +graphs that obfuscate which commit did exactly what change, when and, why. + +Commit Linting is in effect. You may refer to this link for more information: +https://www.conventionalcommits.org/en/v1.0.0-beta.4/#specification + +It is required to 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. +https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits + +**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). + +**A Must Read for Beginners** + +For rebasing and squashing, here's a must read guide for beginners: +https://github.com/servo/servo/wiki/Beginner's-guide-to-rebasing-and-squashing \ No newline at end of file