|
| 1 | +## Description |
| 2 | + |
| 3 | +Please include a summary of the change and which issue is fixed, or what the enhancement does. |
| 4 | +Please also include relevant motivation and context. |
| 5 | +List any dependencies that are required for this change. |
| 6 | + |
| 7 | +## Type of change |
| 8 | +Please delete options that are not relevant. |
| 9 | +- [ ] Bug fix (non-breaking change which fixes an issue) |
| 10 | +- [ ] New feature (non-breaking change which adds functionality) |
| 11 | +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) |
| 12 | +- [ ] This change requires a documentation update |
| 13 | +- [ ] This requires a third party update (such as Impacket, Dploot, lsassy, etc) |
| 14 | + |
| 15 | +## How Has This Been Tested? |
| 16 | +Please describe the tests that you ran to verify your changes (e2e, single commands, etc) |
| 17 | +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 |
| 18 | + |
| 19 | +If you are using poetry, you can easily run tests via: |
| 20 | +`poetry run python tests/e2e_tests.py -t $TARGET -u $USER -p $PASSWORD` |
| 21 | +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 |
| 22 | + |
| 23 | +## Screenshots (if appropriate): |
| 24 | +Screenshots are always nice to have and can give a visual representation of the change. |
| 25 | +If appropriate include before and after screenshot(s) to show which results are to be expected. |
| 26 | + |
| 27 | +## Checklist: |
| 28 | + |
| 29 | +- [ ] I have ran Ruff against my changes (via poetry: `poetry run python -m ruff check . --preview`, use `--fix` to automatically fix what it can) |
| 30 | +- [ ] I have added or updated the tests/e2e_commands.txt file if necessary |
| 31 | +- [ ] New and existing e2e tests pass locally with my changes |
| 32 | +- [ ] My code follows the style guidelines of this project (should be covered by Ruff above) |
| 33 | +- [ ] If reliant on third party dependencies, such as Impacket, dploot, lsassy, etc, I have linked the relevant PRs in those projects |
| 34 | +- [ ] I have performed a self-review of my own code |
| 35 | +- [ ] I have commented my code, particularly in hard-to-understand areas |
| 36 | +- [ ] I have made corresponding changes to the documentation (PR here: https://github.com/Pennyw0rth/NetExec-Wiki) |
0 commit comments