add pull request manner

Signed-off-by: spacewander <[email protected]>
tj · Nov 17, 2023 · 4047cc2 · 4047cc2
1 parent 58c5b50
commit 4047cc2
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 master instead of rebasing.
+* 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`.