Skip to content

Commit 66101e0

Browse files
committed
Add changelog guidelines in the PR template
1 parent 4e0ca9e commit 66101e0

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

.github/pull_request_template.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,13 @@ This will serve as a starting point for your reviewers, for functional testing.
3838
A one line sentence describing the change that this PR introduces.
3939
If this has impact over the user experience, your changelog will be included in the release notes of the next stable version of 1Password CLI.
4040
41-
Have a look over 1Password CLI's past release notes for a some examples:
41+
Here are a few guidelines for writing a good changelog:
42+
- Keep your description to a single sentence if you can, and use proper capitalization and punctuation, including a final period.
43+
- Don't use emoji in your description.
44+
- Avoid starting your sentence with "improved" or "fixed", especially when using those change types. Instead, describe the improvement or say what you fixed.
45+
- Avoid using terminology like "Users are shown" or "You can now" and instead focus on the thing that was changed.
46+
47+
Have a look over 1Password CLI's past release notes for examples:
4248
https://app-updates.agilebits.com/product_history/CLI2
4349
-->
4450

0 commit comments

Comments
 (0)