add pull request manner (#1113)

* add pull request manner Signed-off-by: spacewander <[email protected]> * Update .github/PULL_REQUEST_TEMPLATE.md Thanks for @hyperupcall Co-authored-by: Edwin Kofler <[email protected]> --------- Signed-off-by: spacewander <[email protected]> Co-authored-by: Edwin Kofler <[email protected]>
tj · Nov 21, 2023 · 3d96468 · 3d96468
1 parent ca18c6e
commit 3d96468
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,12 @@
+<!--
+
+Note
+
+* Mark the PR as draft until it's ready to be reviewed.
+* Please update the documentation to reflect the changes made in the PR.
+* If the command is covered by tests under ./tests, please add/update tests for any changes unless you have a good reason. 
+* Make a new commit to resolve conversations instead of `push -f`.
+* To resolve merge conflicts, merge from the `main` branch instead of rebasing over `main`.
+* Please wait for the reviewer to mark a conversation as resolved.
+
+-->
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -38,3 +38,7 @@ Let's say you wish to add a new command. Assuming your new command is named `foo
 8. Run `./check_integrity.sh foo` to check if all done.
 
 You are welcome to open up an issue to discuss new commands or features before opening a pull request.
+
+## Submitting a pull request
+
+Please follow the suggestion in `./.github/PULL_REQUEST_TEMPLATE.md`.