Skip to content

Commit 1e88f83

Browse files
authored
Merge pull request #239 from 1Password/hculea/add-pr-template
Add pull request template
2 parents 00ab385 + a1c52ce commit 1e88f83

1 file changed

Lines changed: 61 additions & 0 deletions

File tree

.github/pull_request_template.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
## Overview
2+
<!--
3+
Provide a high-level description of this change.
4+
-->
5+
6+
7+
8+
## Type of change
9+
<!--
10+
Check the box below that describes your change best:
11+
-->
12+
13+
- [ ] Created a new plugin
14+
- [ ] Improved an existing plugin
15+
- [ ] Fixed a bug in an existing plugin
16+
- [ ] Improved contributor utilities or experience
17+
18+
## Related Issue(s)
19+
<!--
20+
If applicable - add the issue that your PR relates to or closes:
21+
- use Resolves: #ISSUE_NUMBER to trigger closing of the issue on merge of this PR
22+
- use Relates: #ISSUE_NUMBER to indicate relation to an issue, but issue will not close
23+
-->
24+
25+
* Resolves: #
26+
* Relates: #
27+
28+
## How To Test
29+
<!--
30+
Provide testing instructions for validating the changes introduced in this PR.
31+
This will serve as a starting point for your reviewers, for functional testing.
32+
33+
If you created a new plugin, you can add a command here which can be used to test authentication.
34+
For example, for the AWS CLI:
35+
aws s3 ls
36+
-->
37+
38+
39+
40+
## Changelog
41+
<!--
42+
A one line sentence describing the change that this PR introduces.
43+
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.
44+
45+
Here are a few guidelines for writing a good changelog:
46+
- Keep your description to a single sentence if you can, and use proper capitalization and punctuation, including a final period.
47+
- Don't use emoji in your description.
48+
- Avoid starting your sentence with "improved" or "fixed". Instead, describe the improvement or say what you fixed.
49+
- Avoid using terminology like "Users are shown" or "You can now" and instead focus on the thing that was changed.
50+
51+
A few examples:
52+
53+
Authenticate the AWS CLI using Touch ID and other unlock options with 1Password Shell Plugins.
54+
The AWS plugin can now be correctly initialized with a default credential, using `op plugin init`.
55+
The AWS plugin now checks for the `AWS_SHARED_CREDENTIALS_FILE` environment variable and attempts to import credentials using the specified file.
56+
57+
For more examples, have a look over 1Password CLI's past release notes:
58+
https://app-updates.agilebits.com/product_history/CLI2
59+
-->
60+
61+

0 commit comments

Comments
 (0)