Skip to content

Commit e9f366f

Browse files
docs: update PR template
Update the pull request template to clarify AI usage and some additional helpful asks Signed-off-by: Marshall Hallenbeck <Marshall.Hallenbeck@gmail.com>
1 parent 6adb4c4 commit e9f366f

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Insert an "x" inside the brackets for relevant items (do not delete options)
1212
- [ ] Deprecation of feature or functionality
1313
- [ ] This change requires a documentation update
1414
- [ ] This requires a third party update (such as Impacket, Dploot, lsassy, etc)
15+
- [ ] This PR was created with the assistance of AI (list what type of assistance, tool(s)/model(s) in the description)
1516

1617
## Setup guide for the review
1718
Please provide guidance on what setup is needed to test the introduced changes, such as your locally running machine Python version & OS, as well as the target(s) you tested against, including software versions.
@@ -24,7 +25,8 @@ In particular:
2425

2526
## Screenshots (if appropriate):
2627
Screenshots are always nice to have and can give a visual representation of the change.
27-
If appropriate include before and after screenshot(s) to show which results are to be expected.
28+
If appropriate, include before and after screenshot(s) to show which results are to be expected.
29+
Including the commands ran in any screenshots as a `codeblock` in this section is also helpful.
2830

2931
## Checklist:
3032
Insert an "x" inside the brackets for completed and relevant items (do not delete options)
@@ -33,6 +35,6 @@ Insert an "x" inside the brackets for completed and relevant items (do not delet
3335
- [ ] I have added or updated the `tests/e2e_commands.txt` file if necessary (new modules or features are _required_ to be added to the e2e tests)
3436
- [ ] If reliant on changes of third party dependencies, such as Impacket, dploot, lsassy, etc, I have linked the relevant PRs in those projects
3537
- [ ] I have linked relevant sources that describes the added technique (blog posts, documentation, etc)
36-
- [ ] I have performed a self-review of my own code
37-
- [ ] I have commented my code, particularly in hard-to-understand areas
38+
- [ ] I have performed a self-review of my own code (_not_ an AI review)
39+
- [ ] I have commented my code, particularly in hard-to-understand areas (do not add useless comments)
3840
- [ ] I have made corresponding changes to the documentation (PR here: https://github.com/Pennyw0rth/NetExec-Wiki)

0 commit comments

Comments
 (0)