Skip to content

Commit 4399228

Browse files
igorski-r7igorski-r7
committed
Updated template names | Aligned templates
1 parent 336bd55 commit 4399228

File tree

3 files changed

+120
-96
lines changed

3 files changed

+120
-96
lines changed

‎.github/PULL_REQUEST_TEMPLATE/contrib.md‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
## 🧩 Type of Change
2+
<!-- Choose the type of change -->
3+
- [ ] Feature
4+
- [ ] Bug fix
5+
- [ ] Other
6+
7+
## 🧠 Background & Motivation
8+
<!-- Why is this change needed? What problem or context led to this PR? -->
9+
<!-- Provide a short explanation of the motivation and the problem being solved. -->
10+
<!-- Examples:
11+
- "Users reported X error when doing Y"
12+
- "New feature X was requested"
13+
-->
14+
15+
## ✨ What Changed
16+
<!-- What was done? Summarize the key changes in this PR. -->
17+
<!-- Describe the core implementation and high-level impact. -->
18+
<!-- Examples:
19+
- "Added new action 'X' to plugin Y"
20+
- "Refactored X to improve performance"
21+
-->
22+
23+
## 🧪 Testing
24+
<!-- Describe how you verified the changes work as intended -->
25+
<!-- Include details of your testing process, such as:
26+
- Unit tests
27+
- Manual testing steps
28+
- Any relevant screenshots or logs
29+
-->
30+
31+
### ✅ Checklist
32+
- [ ] Unit tests added/updated ([generation guide](https://docs.rapid7.com/insightconnect/unit-test-generation) | [writing guide](https://docs.rapid7.com/insightconnect/unit-test-primer))
33+
- [ ] Manually tested in InsightConnect (if applicable)
34+
35+
### 🔍 Plugin Validation
36+
37+
Please run the following commands and provide the output. **For action/trigger tests and runs, include outputs for all actions/triggers that were created or modified in this PR.**
38+
39+
<details>
40+
<summary>Plugin Validation Output (<code>insight-plugin validate</code>)</summary>
41+
42+
```
43+
# Paste output here
44+
```
45+
46+
</details>
47+
48+
<details>
49+
<summary>Connection Test Results (<code>insight-plugin run -T tests/example.json --debug --jq</code>)</summary>
50+
51+
```
52+
# Paste output here for the connection test of the plugin
53+
# It doesn't matter which action/trigger you use, as long as -T flag is specified
54+
```
55+
56+
</details>
57+
58+
<details>
59+
<summary>Action/Trigger Test Results (<code>insight-plugin run -R tests/example.json --debug --jq</code>)</summary>
60+
61+
```
62+
# Paste output here for all created/modified actions/triggers
63+
```
64+
65+
</details>
66+
67+
### 🖼️ In-Product Verification (if applicable)
68+
69+
If you have access to an InsightConnect instance, please provide:
70+
- [ ] Screenshot of job output with the plugin changes
71+
- [ ] Screenshot of the changed connection, actions, or triggers input within the InsightConnect workflow builder
72+
73+
## ✅ Code Quality Checklist
74+
75+
Please review our [style guide](https://docs.rapid7.com/insightconnect/style-guide/) and check all that apply:
76+
- [ ] Dependencies pinned in `Dockerfile` ([OS packages](https://docs.rapid7.com/insightconnect/style-guide/#dockerfile)) and `requirements.txt` ([Python packages](https://docs.rapid7.com/insightconnect/style-guide/#requirements.txt))
77+
- [ ] `USER nobody` set in `Dockerfile` for least privileged account
78+
- [ ] Uses [slim SDK images](https://docs.rapid7.com/insightconnect/sdk-guide/#sdk-guide) when possible (e.g., `rapid7/insightconnect-python-3-38-slim-plugin:{sdk-version-num}`)
79+
- [ ] Uses [PluginException](https://docs.rapid7.com/insightconnect/error-handling-in-integrations/#plugin-exceptions) / [ConnectionTestException](https://docs.rapid7.com/insightconnect/error-handling-in-integrations#connection-exceptions) for errors
80+
- [ ] Uses `self.logger` for [logging](https://docs.rapid7.com/insightconnect/sdk-guide/#logging)
81+
- [ ] Changelog updated ([style guide](https://docs.rapid7.com/insightconnect/style-guide/#changelog))
82+
- [ ] Work fully completed and functional
83+
84+
## 💬 Additional Notes
85+
<!-- Screenshots, breaking changes, migration notes, or anything else reviewers should know -->
86+
87+
---
88+
89+
**Thanks for contributing! 🎉**

‎.github/PULL_REQUEST_TEMPLATE/core.md‎

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎.github/pull_request_template.md‎

Lines changed: 31 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,34 @@
1-
## 📝 Description
2-
3-
<!-- Briefly describe your changes, why they're needed, and any relevant context -->
4-
*Provide a short description of the changes made in this pull request.*
1+
## 🎫 Ticket
2+
<!-- Link to the related Jira ticket (if applicable, typically for features and bug fixes) -->
3+
<!-- If no ticket exists, you can remove this section or write "N/A" -->
4+
<!-- Ticket: [<insert ticket title>](<insert ticket link>) -->
5+
6+
## 🧩 Type of Change
7+
<!-- Choose the type of change -->
8+
- [ ] Feature
9+
- [ ] Bug fix
10+
- [ ] Other
11+
12+
## 🧠 Background & Motivation
13+
<!-- Why is this change needed? What problem or context led to this PR? -->
14+
<!-- Provide a short explanation of the motivation and the problem being solved. -->
15+
<!-- Examples:
16+
- "Users reported X error when doing Y"
17+
- "New feature X was requested"
18+
-->
19+
20+
## ✨ What Changed
21+
<!-- What was done? Summarize the key changes in this PR. -->
22+
<!-- Describe the core implementation and high-level impact. -->
23+
<!-- Examples:
24+
- "Added new action 'X' to plugin Y"
25+
- "Refactored X to improve performance"
26+
-->
527

628
## 🧪 Testing
7-
829
<!-- Describe how you verified the changes work as intended -->
9-
*Describe the testing process, including any unit tests or manual testing steps taken.*
10-
11-
### ✅ Checklist
12-
- [ ] Unit tests added/updated ([generation guide](https://docs.rapid7.com/insightconnect/unit-test-generation) | [writing guide](https://docs.rapid7.com/insightconnect/unit-test-primer))
13-
- [ ] Manually tested in InsightConnect (if applicable)
14-
15-
### 🔍 Plugin Validation
16-
17-
Please run the following commands and provide the output. **For action/trigger tests and runs, include outputs for all actions/triggers that were created or modified in this PR.**
18-
19-
<details>
20-
<summary>Plugin Validation Output (<code>insight-plugin validate</code>)</summary>
21-
22-
```
23-
# Paste output here
24-
```
25-
26-
</details>
27-
28-
<details>
29-
<summary>Connection Test Results (<code>insight-plugin run -T tests/example.json --debug --jq</code>)</summary>
30-
31-
```
32-
# Paste output here for the connection test of the plugin
33-
# It doesn't matter which action/trigger you use, as long as -T flag is specified
34-
```
35-
36-
</details>
37-
38-
<details>
39-
<summary>Action/Trigger Test Results (<code>insight-plugin run -R tests/example.json --debug --jq</code>)</summary>
40-
41-
```
42-
# Paste output here for all created/modified actions/triggers
43-
```
44-
45-
</details>
46-
47-
### 🖼️ In-Product Verification (if applicable)
48-
49-
If you have access to an InsightConnect instance, please provide:
50-
- [ ] Screenshot of job output with the plugin changes
51-
- [ ] Screenshot of the changed connection, actions, or triggers input within the InsightConnect workflow builder
52-
53-
## ✅ Code Quality Checklist
54-
55-
Please review our [style guide](https://docs.rapid7.com/insightconnect/style-guide/) and check all that apply:
56-
- [ ] Dependencies pinned in `Dockerfile` ([OS packages](https://docs.rapid7.com/insightconnect/style-guide/#dockerfile)) and `requirements.txt` ([Python packages](https://docs.rapid7.com/insightconnect/style-guide/#requirements.txt))
57-
- [ ] `USER nobody` set in `Dockerfile` for least privileged account
58-
- [ ] Uses [slim SDK images](https://docs.rapid7.com/insightconnect/sdk-guide/#sdk-guide) when possible (e.g., `rapid7/insightconnect-python-3-38-slim-plugin:{sdk-version-num}`)
59-
- [ ] Uses [PluginException](https://docs.rapid7.com/insightconnect/error-handling-in-integrations/#plugin-exceptions) / [ConnectionTestException](https://docs.rapid7.com/insightconnect/error-handling-in-integrations#connection-exceptions) for errors
60-
- [ ] Uses `self.logger` for [logging](https://docs.rapid7.com/insightconnect/sdk-guide/#logging)
61-
- [ ] Changelog updated ([style guide](https://docs.rapid7.com/insightconnect/style-guide/#changelog))
62-
- [ ] Work fully completed and functional
63-
64-
## 💬 Additional Notes
65-
66-
<!-- Screenshots, breaking changes, migration notes, or anything else reviewers should know -->
67-
*Add any additional context or information about the pull request here.*
68-
69-
---
70-
71-
**Thanks for contributing! 🎉**
30+
<!-- Include details of your testing process, such as:
31+
- Unit tests
32+
- Manual testing steps
33+
- Any relevant screenshots or logs
34+
-->

0 commit comments

Comments
 (0)