Skip to content

Commit

Permalink
chore: update pull-request template
Browse files Browse the repository at this point in the history
With the adoption of mergify, we now use the `## Description` section as the commit message. Update the PR template to guide users towards crafting a good commit message. Specifically, ask them to point to relevant issues and PRs at the end of the message instead of in a separate section.

Pull-Request: libp2p#3570.
  • Loading branch information
thomaseizinger authored Mar 10, 2023
1 parent 0def960 commit ad02201
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
## 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. -->
<!--
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.
For a quick primer on good commit mesages, check out this blog post: https://cbea.ms/git-commit/
## Notes
Please include any relevant issues in here, for example:
<!-- Any notes or remarks you'd like to make about the PR. -->
Related https://github.com/libp2p/rust-libp2p/issues/ABCD.
Fixes https://github.com/libp2p/rust-libp2p/issues/XYZ.
-->

## Links to any relevant issues
## Notes & open questions

<!-- Reference any related issues.-->

## Open Questions

<!-- Unresolved questions, if any. -->
<!--
Any notes, remarks or open questions you have to make about the PR which don't need to go into the final commit message.
-->

## Change checklist

Expand Down

0 comments on commit ad02201

Please sign in to comment.