Skip to content

Commit c42997c

Browse files
committed
Add examples for changelogs in PR template
1 parent 66101e0 commit c42997c

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

.github/pull_request_template.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,16 @@ If this has impact over the user experience, your changelog will be included in
4141
Here are a few guidelines for writing a good changelog:
4242
- Keep your description to a single sentence if you can, and use proper capitalization and punctuation, including a final period.
4343
- 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.
44+
- Avoid starting your sentence with "improved" or "fixed". Instead, describe the improvement or say what you fixed.
4545
- Avoid using terminology like "Users are shown" or "You can now" and instead focus on the thing that was changed.
4646
47-
Have a look over 1Password CLI's past release notes for examples:
47+
A few examples:
48+
49+
Authenticate the AWS CLI using Touch ID and other unlock options with 1Password Shell Plugins.
50+
The AWS plugin can now be correctly initialised with a default credential, using 'op plugin init'.
51+
The AWS plugin now checks for the 'AWS_SHARED_CREDENTIALS_FILE' environment variable and attempts to import credentials using the specified file.
52+
53+
For more examples, have a look over 1Password CLI's past release notes:
4854
https://app-updates.agilebits.com/product_history/CLI2
4955
-->
5056

0 commit comments

Comments
 (0)