docs: add Pull Request Template

fixes: #91 adds Pull Request Template on the root directory as guideline for contributors. Signed-off-by: ruzell22 <[email protected]>
hyperledger-cacti · Oct 3, 2023 · 3ee4d86 · 3ee4d86
1 parent b7ad571
commit 3ee4d86
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +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.
+
+**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](https://github.com/servo/servo/wiki/Beginner's-guide-to-rebasing-and-squashing) for beginners.