From 12d2b234a650d2813a1d10690dff0ba6bcaebba9 Mon Sep 17 00:00:00 2001
From: Caleb Stewart <caleb.stewart94@gmail.com>
Date: Sun, 13 Jun 2021 20:23:24 -0400
Subject: [PATCH] Added pull request templates

---
 .github/PULL_REQUEST_TEMPLATE/bug_fix.md | 26 +++++++++++++++
 .github/PULL_REQUEST_TEMPLATE/feature.md | 22 +++++++++++++
 .github/PULL_REQUEST_TEMPLATE/module.md  | 40 ++++++++++++++++++++++++
 3 files changed, 88 insertions(+)
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/bug_fix.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/feature.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/module.md

diff --git a/.github/PULL_REQUEST_TEMPLATE/bug_fix.md b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md
new file mode 100644
index 0000000..11d9bb0
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md
@@ -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.
diff --git a/.github/PULL_REQUEST_TEMPLATE/feature.md b/.github/PULL_REQUEST_TEMPLATE/feature.md
new file mode 100644
index 0000000..f544d0e
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/feature.md
@@ -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.
diff --git a/.github/PULL_REQUEST_TEMPLATE/module.md b/.github/PULL_REQUEST_TEMPLATE/module.md
new file mode 100644
index 0000000..5dd4add
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/module.md
@@ -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.