mirror of
https://github.com/flame-engine/flame.git
synced 2025-11-02 20:13:50 +08:00
docs: Fix positioning of git commit message exclusion blocks in the PR template (#3016)
Fix positioning of git commit message exclusion blocks in the PR template. I found it a bit confusing as I think what we want to encourage is that the migration instructions go into the git message, but rn there is just a "Replace or remove this text." lost after the related issues. I don't think we want to include related issues? So it seems just out of order. --------- Co-authored-by: Lukas Klingsbo <me@lukas.fyi>
This commit is contained in:
7
.github/pull_request_template.md
vendored
7
.github/pull_request_template.md
vendored
@ -49,8 +49,10 @@ instructions" section below.
|
||||
### Migration instructions
|
||||
|
||||
If the PR is breaking, uncomment this header and add instructions for how to migrate from the
|
||||
currently released version to the new proposed way.
|
||||
currently released version in-between the two following tags:
|
||||
-->
|
||||
<!-- End of exclude from commit message -->
|
||||
<!-- Exclude from commit message -->
|
||||
|
||||
## Related Issues
|
||||
<!--
|
||||
@ -58,10 +60,7 @@ Indicate which issues this PR resolves, if any. For example:
|
||||
|
||||
Closes #1234
|
||||
!-->
|
||||
<!-- End of exclude from commit message -->
|
||||
Replace or remove this text.
|
||||
|
||||
<!-- Exclude from commit message -->
|
||||
<!-- Links -->
|
||||
[Contributor Guide]: https://github.com/flame-engine/flame/blob/main/CONTRIBUTING.md
|
||||
[Conventional Commit]: https://conventionalcommits.org
|
||||
|
||||
Reference in New Issue
Block a user