Skip to content

Commit 67a1dc0

Browse files
committed
chore: add PR templates
to standardize PR documentation
1 parent b996e3a commit 67a1dc0

File tree

3 files changed

+99
-0
lines changed

3 files changed

+99
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Click the `Preview` tab and select a PR template:
2+
3+
- [Default Template](?expand=1&template=default.md)
4+
- [Plugin](?expand=1&template=plugin.md)
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Summary
2+
3+
One-liner - what does this change?
4+
5+
## Links
6+
7+
- Jira/Notion:
8+
- Issue link:
9+
- Other useful links:
10+
11+
## Changes
12+
13+
(Answer where applicable)
14+
15+
- Why this PR is needed?
16+
- What does this add?
17+
- What does this deprecate?
18+
- What does this improve?
19+
20+
## Related Changes
21+
22+
- Does this have a dependant PR? Eg. link to original PR if this is a bug fix PR.
23+
24+
(Use table to list all related PRs if done in parts)
25+
26+
| Description | PR |
27+
| --- | --- |
28+
| [Part 1] This PR | ⬅️ |
29+
| [Part 2] Another PR | link |
30+
| [Part 3] Another PR | link |
31+
32+
## Dev Testing
33+
34+
(Include where applicable)
35+
36+
- Screenshots
37+
- Video Recordings
38+
39+
## Pre-release Checklist
40+
41+
- [ ] QA/PM's approval
42+
- [ ] (If files are removed) Check all usages of the deleted files
43+
44+
## Rollback Steps
45+
46+
- Any steps to follow in the event of rollback due to breaking release. Eg. toggle feature flag, revert commit etc.
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Summary
2+
3+
One-liner – What does this plugin contribution add or change?
4+
5+
## Links
6+
7+
- Plugin documentation:
8+
- Issue link (if applicable):
9+
- Other useful links:
10+
11+
## Description
12+
13+
(Answer where applicable)
14+
15+
- Why is this plugin contribution needed?
16+
- What functionality does this plugin add or enhance?
17+
- What dependencies or integrations does it introduce?
18+
19+
## Plugin Details
20+
21+
- Plugin Name:
22+
- Compatibility Notes (if applicable):
23+
- Additional Setup Instructions (if required):
24+
25+
## Plugin Documentation Checklist
26+
27+
- README Validation
28+
- [ ] Clear installation instructions
29+
- [ ] Usage examples with code snippets
30+
- [ ] List of features and capabilities
31+
- [ ] Troubleshooting guide (if applicable)
32+
- [ ] Contribution guidelines (if applicable)
33+
34+
- Metadata Validation
35+
- [ ] Complete metadata provided in reference to [plugin metadata template](../.././plugins/plugin_metadata_template.yml)
36+
37+
## Dev Testing
38+
39+
(Include where applicable)
40+
41+
- Screenshots/GIFs
42+
- Video Demonstrations
43+
- Logs or Console Outputs
44+
- Testing steps for the plugin
45+
46+
## Additional Notes
47+
48+
- Any considerations for future updates or enhancements.
49+
- Known issues or limitations with this plugin contribution.

0 commit comments

Comments
 (0)