|
1 | | ---- |
2 | | -name: Pull request |
3 | | -about: Update code to fix a bug or add an enhancement/feature |
4 | | -title: '' |
5 | | -labels: '' |
6 | | -assignees: '' |
7 | | - |
8 | | ---- |
9 | 1 | ## Description |
10 | 2 |
|
11 | 3 | 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 | 4 | List any dependencies that are required for this change. |
14 | 5 |
|
15 | 6 | ## Type of change |
16 | | -Please delete options that are not relevant. |
| 7 | +Insert an "x" inside the brackets for relevant items (do not delete options) |
| 8 | + |
17 | 9 | - [ ] Bug fix (non-breaking change which fixes an issue) |
18 | 10 | - [ ] New feature (non-breaking change which adds functionality) |
19 | 11 | - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) |
| 12 | +- [ ] Deprecation of feature or functionality |
20 | 13 | - [ ] This change requires a documentation update |
21 | 14 | - [ ] This requires a third party update (such as Impacket, Dploot, lsassy, etc) |
22 | 15 |
|
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 |
| 16 | +## Setup guide for the review |
| 17 | +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. |
| 18 | +In particular: |
| 19 | +- Bug Fix: Please provide a short description on how to trigger the bug, to make the bug reproducable for the reviewer. |
| 20 | +- Added Feature/Enhancement: Please specify what setup is needed in order to test the changes. E.g. is additional software needed? GPO changes required? Specific registry settings that need to be changed? |
30 | 21 |
|
31 | 22 | ## Screenshots (if appropriate): |
32 | 23 | Screenshots are always nice to have and can give a visual representation of the change. |
33 | 24 | If appropriate include before and after screenshot(s) to show which results are to be expected. |
34 | 25 |
|
35 | 26 | ## Checklist: |
| 27 | +Insert an "x" inside the brackets for completed and relevant items (do not delete options) |
36 | 28 |
|
37 | 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) |
38 | | -- [ ] I have added or updated the tests/e2e_commands.txt file if necessary |
| 30 | +- [ ] 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) |
39 | 31 | - [ ] New and existing e2e tests pass locally with my changes |
40 | | -- [ ] My code follows the style guidelines of this project (should be covered by Ruff above) |
41 | | -- [ ] If reliant on third party dependencies, such as Impacket, dploot, lsassy, etc, I have linked the relevant PRs in those projects |
| 32 | +- [ ] If reliant on changes of third party dependencies, such as Impacket, dploot, lsassy, etc, I have linked the relevant PRs in those projects |
42 | 33 | - [ ] I have performed a self-review of my own code |
43 | 34 | - [ ] I have commented my code, particularly in hard-to-understand areas |
44 | 35 | - [ ] I have made corresponding changes to the documentation (PR here: https://github.com/Pennyw0rth/NetExec-Wiki) |
0 commit comments