Skip to content

Commit 38d2c4a

Browse files
committed
github: update pull request template
Signed-off-by: Yuxuan Shui <[email protected]>
1 parent cd4a25c commit 38d2c4a

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

.github/pull_request_template.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
1-
<!-- Please enable "Allow edits from maintainers" so we can make necessary changes to your PR -->
1+
## Summary
22

3-
# Changelog
3+
<!-- If your pull request includes many commits, please provide a summary,
4+
otherwise delete this section. We prefer you put detailed descriptions
5+
in the commit messages. -->
46

5-
<!-- If you want to add a changelog entry for this PR, write it here; otherwise delete this section -->
6-
* Category: (Bug fixes, new features, etc.)
7-
* Description: (Describe changes made)
7+
## Checklist
8+
9+
- [ ] Enable "Allow edits from maintainers". (So we can make necessary changes).
10+
- [ ] Add changelog entries to commit messages when appropriate. These will be included in release announcements.
11+
<details>
12+
Format the changelog entries like this:
13+
14+
`Changelog: BugFix: Stop picom from summoning the Great Old Ones.`
15+
16+
The entry starts with `Changelog: `, followed by a category name (`BugFix: ` in this case), then a short description of the changes in the commit.
17+
<summary>How to format changelog entries</summary>
18+
</details>

0 commit comments

Comments
 (0)