.github/: Use Description for commit message and add Notes (#3082)

libp2p · Nov 13, 2022 · cafa734 · cafa734
1 parent afb777e
commit cafa734
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/.github/mergify.yml b/.github/mergify.yml
@@ -5,7 +5,7 @@ defaults:
       commit_message_template: |
         {{ title }} (#{{ number }})
         
-        {{ body | get_section("## Commit Message body", "") }}   
+        {{ body | get_section("## Description", "") }}   
 
 pull_request_rules:
   - name: Ask to resolve conflict

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,12 +1,16 @@
-# Description
+## Description
 
 <!-- Please write a summary of your changes and why you made them.-->
+<!-- This section will appear as the commit message after merging. Please craft it accordingly. -->
+
+## Notes
+
+<!-- Any notes or remarks you'd like to make about the PR. -->
 
 ## Links to any relevant issues
 
 <!-- Reference any related issues.-->
 
-
 ## Open Questions
 
 <!-- Unresolved questions, if any. -->
@@ -19,6 +23,3 @@
 - [ ] I have made corresponding changes to the documentation
 - [ ] I have added tests that prove my fix is effective or that my feature works
 - [ ] A changelog entry has been made in the appropriate crates
-
-<!-- The below text will appear as the commit message body once we squash-merge the PR. -->
-## Commit message body