Skip to content

Commit 3ff3692

Browse files
committed
Updated contributing instructions to include changing PR template
1 parent 4399228 commit 3ff3692

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

.github/PULL_REQUEST_TEMPLATE/contrib.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ If you have access to an InsightConnect instance, please provide:
7575
Please review our [style guide](https://docs.rapid7.com/insightconnect/style-guide/) and check all that apply:
7676
- [ ] 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))
7777
- [ ] `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}`)
78+
- [ ] Uses [slim SDK images](https://docs.rapid7.com/insightconnect/sdk-guide/#sdk-guide) when possible (e.g., `rapid7/insightconnect-python-3-slim-plugin:{sdk-version-num}`)
7979
- [ ] 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
8080
- [ ] Uses `self.logger` for [logging](https://docs.rapid7.com/insightconnect/sdk-guide/#logging)
8181
- [ ] Changelog updated ([style guide](https://docs.rapid7.com/insightconnect/style-guide/#changelog))

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,24 @@ it into production. If you do not care to follow these rules, your contribution
3333
- **Don't** leave your pull request description blank.
3434
- **Don't** abandon your pull request. Being responsive helps us land your code faster.
3535

36+
#### Using the Contributor PR Template (External Contributors)
37+
38+
**If you're contributing from a fork**, please use our specialized contributor template that includes additional validation sections. Here's how:
39+
40+
1. When you click "Compare & Pull request" on GitHub after pushing your changes, you'll see a URL like:
41+
```
42+
https://github.com/rapid7/insightconnect-plugins/compare/master...your-username:your-branch
43+
```
44+
45+
2. Before clicking "Create pull request", add `?template=contrib.md` to the end of the URL:
46+
```
47+
https://github.com/rapid7/insightconnect-plugins/compare/master...your-username:your-branch?template=contrib.md
48+
```
49+
50+
3. Press Enter to reload the page with the contributor template pre-filled.
51+
52+
This template includes sections for plugin validation outputs, connection tests, and code quality checklists that help us review external contributions more efficiently.
53+
3654
#### New Features
3755

3856
- **Do** install validator dependencies necessary to run `make validate` to find and fix any errors or warnings that come up.

0 commit comments

Comments
 (0)