Skip to content

Commit aedfc37

Browse files
Create pull_request_template.md
Signed-off-by: Marshall Hallenbeck <Marshall.Hallenbeck@gmail.com>
1 parent a677b37 commit aedfc37

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Pull request
3+
about: Updating code to fix a bug or add an enhancement/feature
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
## Description
10+
11+
Please include a summary of the change and which issue is fixed, or what the enhancement does.
12+
Please also include relevant motivation and context.
13+
List any dependencies that are required for this change.
14+
15+
## Type of change
16+
Please delete options that are not relevant.
17+
- [ ] Bug fix (non-breaking change which fixes an issue)
18+
- [ ] New feature (non-breaking change which adds functionality)
19+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
20+
- [ ] This change requires a documentation update
21+
- [ ] This requires a third party update (such as Impacket, Dploot, lsassy, etc)
22+
23+
## How Has This Been Tested?
24+
Please describe the tests that you ran to verify your changes (e2e, single commands, etc)
25+
Please also list any relevant details for your test configuration, such as your locally running machine Python version & OS, as well as the target(s) you tested against, including software versions
26+
27+
If you are using poetry, you can easily run tests via:
28+
`poetry run python tests/e2e_tests.py -t $TARGET -u $USER -p $PASSWORD`
29+
There are additional options like `--errors` to display ALL errors (some may not be failures), `--poetry` (output will include the poetry run prepended), `--line-num $START-$END $SINGLE` for only running a subset
30+
31+
## Checklist:
32+
33+
- [ ] I have ran Ruff against my changes (via poetry: `poetry run python -m ruff check . --preview`, use `--fix` to automatically fix what it can)
34+
- [ ] I have added or updated the tests/e2e_commands.txt file if necessary
35+
- [ ] New and existing e2e tests pass locally with my changes
36+
- [ ] My code follows the style guidelines of this project (should be covered by Ruff above)
37+
- [ ] If reliant on third party dependencies, such as Impacket, dploot, lsassy, etc, I have linked the relevant PRs in those projects
38+
- [ ] I have performed a self-review of my own code
39+
- [ ] I have commented my code, particularly in hard-to-understand areas
40+
- [ ] I have made corresponding changes to the documentation (PR here: https://github.com/Pennyw0rth/NetExec-Wiki)

0 commit comments

Comments
 (0)