mirror of
https://github.com/calebstewart/pwncat.git
synced 2024-11-30 12:24:14 +01:00
Added pull request templates
This commit is contained in:
parent
34bea8eccc
commit
12d2b234a6
26
.github/PULL_REQUEST_TEMPLATE/bug_fix.md
vendored
Normal file
26
.github/PULL_REQUEST_TEMPLATE/bug_fix.md
vendored
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
---
|
||||||
|
name: Bug/Issue Fix
|
||||||
|
about: Merge changes to fix an outstanding bug/issue
|
||||||
|
title: "[FIX #XXX] "
|
||||||
|
labels: fix
|
||||||
|
assignees: ""
|
||||||
|
---
|
||||||
|
Fixes #.
|
||||||
|
|
||||||
|
Changes proposed in this pull request:
|
||||||
|
-
|
||||||
|
-
|
||||||
|
-
|
||||||
|
|
||||||
|
**note - remove following before post submitting, please :)**
|
||||||
|
|
||||||
|
The following should be completed before opening a pull request:
|
||||||
|
|
||||||
|
- `isort` any modified files.
|
||||||
|
- `black` format any modified files
|
||||||
|
- Correct any outstanding `flake8` errors.
|
||||||
|
- Note any `noqa:` comments need in your PR to appease flake.
|
||||||
|
|
||||||
|
Include a description of your fix in the body, and enumerate any
|
||||||
|
changes which could have external consequences/sid-effects. Think
|
||||||
|
about things like API or usage changes.
|
22
.github/PULL_REQUEST_TEMPLATE/feature.md
vendored
Normal file
22
.github/PULL_REQUEST_TEMPLATE/feature.md
vendored
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
---
|
||||||
|
name: Feature Implementation
|
||||||
|
about: Merge changes to add a new feature
|
||||||
|
title: "[FEATURE] "
|
||||||
|
labels: enhancement
|
||||||
|
assignees: ""
|
||||||
|
---
|
||||||
|
|
||||||
|
Describe the changes you've made and how they improve the framework.
|
||||||
|
|
||||||
|
Changes proposed in this pull request:
|
||||||
|
- Enumerate high-level changes made to the framework here.
|
||||||
|
- Thinkg about how this change/feature changes the API or usage.
|
||||||
|
|
||||||
|
**note - remove following before post submitting, please :)**
|
||||||
|
|
||||||
|
The following should be completed before opening a pull request:
|
||||||
|
|
||||||
|
- `isort` any modified files.
|
||||||
|
- `black` format any modified files
|
||||||
|
- Correct any outstanding `flake8` errors.
|
||||||
|
- Note any `noqa:` comments needed to appease flake above.
|
40
.github/PULL_REQUEST_TEMPLATE/module.md
vendored
Normal file
40
.github/PULL_REQUEST_TEMPLATE/module.md
vendored
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
---
|
||||||
|
name: New Module
|
||||||
|
about: Merge changes to add a new pwncat module
|
||||||
|
title: "[NEW-MODULE] "
|
||||||
|
labels:
|
||||||
|
- enhancement
|
||||||
|
- new-module
|
||||||
|
assignees: ""
|
||||||
|
---
|
||||||
|
|
||||||
|
**Module Goals**
|
||||||
|
*Describe in detail what your module is for, and how it accomplishes
|
||||||
|
the task from a technical standpoint.*
|
||||||
|
|
||||||
|
**Platform Restrictions:**
|
||||||
|
*Linux/Windows/None/etc*
|
||||||
|
|
||||||
|
**Fully Qualified Name:**
|
||||||
|
*enumerate.something.cool*
|
||||||
|
|
||||||
|
**Environment Restrictions:**
|
||||||
|
*Anything that is required in the environment for the module to function*
|
||||||
|
|
||||||
|
**Artifacts Generated:**
|
||||||
|
*List any artifacts that this module may generate on the victim*
|
||||||
|
|
||||||
|
**Tested Targets**
|
||||||
|
*Where have you tested this module? What have you done to test against
|
||||||
|
verious distributions/systems and ensure wide-coverage? Does the module
|
||||||
|
behave properly (e.g. raise appropriate exception, fail silently) if the
|
||||||
|
environment doesn't match?*
|
||||||
|
|
||||||
|
**note - remove following before post submitting, please :)**
|
||||||
|
|
||||||
|
The following should be completed before opening a pull request:
|
||||||
|
|
||||||
|
- `isort` any modified files.
|
||||||
|
- `black` format any modified files
|
||||||
|
- Correct any outstanding `flake8` errors.
|
||||||
|
- Note any `noqa:` comments need in your PR to appease flake.
|
Loading…
Reference in New Issue
Block a user