From aedfc37a19523bc6f726d842d876b438be4108d1 Mon Sep 17 00:00:00 2001 From: Marshall Hallenbeck Date: Fri, 10 May 2024 15:44:24 -0400 Subject: [PATCH 1/4] Create pull_request_template.md Signed-off-by: Marshall Hallenbeck --- .../ISSUE_TEMPLATE/pull_request_template.md | 40 +++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/pull_request_template.md b/.github/ISSUE_TEMPLATE/pull_request_template.md new file mode 100644 index 000000000..0a4e2b4ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/pull_request_template.md @@ -0,0 +1,40 @@ +--- +name: Pull request +about: Updating code to fix a bug or add an enhancement/feature +title: '' +labels: '' +assignees: '' + +--- +## Description + +Please include a summary of the change and which issue is fixed, or what the enhancement does. +Please also include relevant motivation and context. +List any dependencies that are required for this change. + +## Type of change +Please delete options that are not relevant. +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update +- [ ] This requires a third party update (such as Impacket, Dploot, lsassy, etc) + +## How Has This Been Tested? +Please describe the tests that you ran to verify your changes (e2e, single commands, etc) +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 + +If you are using poetry, you can easily run tests via: +`poetry run python tests/e2e_tests.py -t $TARGET -u $USER -p $PASSWORD` +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 + +## Checklist: + +- [ ] I have ran Ruff against my changes (via poetry: `poetry run python -m ruff check . --preview`, use `--fix` to automatically fix what it can) +- [ ] I have added or updated the tests/e2e_commands.txt file if necessary +- [ ] New and existing e2e tests pass locally with my changes +- [ ] My code follows the style guidelines of this project (should be covered by Ruff above) +- [ ] If reliant on third party dependencies, such as Impacket, dploot, lsassy, etc, I have linked the relevant PRs in those projects +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation (PR here: https://github.com/Pennyw0rth/NetExec-Wiki) From 5c39381dfc366982bd22c226e9a3fc0912857478 Mon Sep 17 00:00:00 2001 From: Marshall Hallenbeck Date: Fri, 10 May 2024 15:51:28 -0400 Subject: [PATCH 2/4] docs: update feature_request.md to include proper template code --- .github/ISSUE_TEMPLATE/feature_request.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index c5b6f4085..9f9cc76c0 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,3 +1,11 @@ +--- +name: Feature request +about: Request a new feature or enhancement +title: '' +labels: '' +assignees: '' + +--- **Please Describe The Problem To Be Solved** (Replace This Text: Please present a concise description of the problem to be addressed by this feature request. Please be clear what parts of the problem are considered to be in-scope and out-of-scope.) From daede6d00a9eefc5de30bedb0bc0b52edfca7b50 Mon Sep 17 00:00:00 2001 From: Marshall Hallenbeck Date: Fri, 10 May 2024 15:52:11 -0400 Subject: [PATCH 3/4] fix english --- .github/ISSUE_TEMPLATE/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/pull_request_template.md b/.github/ISSUE_TEMPLATE/pull_request_template.md index 0a4e2b4ee..fd4ca01d1 100644 --- a/.github/ISSUE_TEMPLATE/pull_request_template.md +++ b/.github/ISSUE_TEMPLATE/pull_request_template.md @@ -1,6 +1,6 @@ --- name: Pull request -about: Updating code to fix a bug or add an enhancement/feature +about: Update code to fix a bug or add an enhancement/feature title: '' labels: '' assignees: '' From 93441f2190dffe4edcc0aaa38d3119a84ac0c02b Mon Sep 17 00:00:00 2001 From: Alexander Neff Date: Fri, 10 May 2024 17:41:09 -0400 Subject: [PATCH 4/4] Add screenshot section to PR template --- .github/ISSUE_TEMPLATE/pull_request_template.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/pull_request_template.md b/.github/ISSUE_TEMPLATE/pull_request_template.md index fd4ca01d1..d345ef996 100644 --- a/.github/ISSUE_TEMPLATE/pull_request_template.md +++ b/.github/ISSUE_TEMPLATE/pull_request_template.md @@ -28,6 +28,10 @@ If you are using poetry, you can easily run tests via: `poetry run python tests/e2e_tests.py -t $TARGET -u $USER -p $PASSWORD` 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 +## Screenshots (if appropriate): +Screenshots are always nice to have and can give a visual representation of the change. +If appropriate include before and after screenshot(s) to show which results are to be expected. + ## Checklist: - [ ] I have ran Ruff against my changes (via poetry: `poetry run python -m ruff check . --preview`, use `--fix` to automatically fix what it can)