From b1e2603855d2f731f1b0385eaaabfbfc5a3ba62e Mon Sep 17 00:00:00 2001
From: Caleb Stewart <caleb.stewart94@gmail.com>
Date: Tue, 15 Jun 2021 16:37:44 -0400
Subject: [PATCH] Added Pull Request template and contributing instructions

---
 .github/pull_request_template.md | 36 ++++++++++++++++++++++++++++++++
 CHANGELOG.md                     |  2 ++
 CONTRIBUTING.md                  | 21 +++++++++++++++++++
 3 files changed, 59 insertions(+)
 create mode 100644 .github/pull_request_template.md

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..ba8a88c
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,36 @@
+## Description of Changes
+
+Fixes #XXX.
+
+**Please note any `noqa:` comments needed to appease flake8.**
+
+## Major Changes Implemented:
+- 
+- 
+- 
+
+## Pre-Merge Tasks
+- [ ] Formatted all modified files w/ `python-black`
+- [ ] Sorted imports for modified files w/ `isort`
+- [ ] Ran `flake8` on repo, and fixed any new problems w/ modified files
+- [ ] Ran `pytest` test cases
+- [ ] Added brief summary of updates to CHANGELOG (under `[Unreleased]`)
+
+**For issues with pre-merge tasks, see CONTRIBUTING.md**
+
+<!--
+If you are submitting a pull request for a new module, the following
+information is also helpful:
+
+## Platform and Environment Restrictions
+(e.g. "Windows targets without HOTFIX XXXXXX")
+
+## Full Qualified Module Name
+(e.g. "linux.enumerate.system.network")
+
+## Artifacts Generated
+(e.g. "creates file at /etc/something.ini tracked w/ a tamper")
+
+## Tested Targets
+(e.g. "Tested on Windows 10 1604")
+-->
diff --git a/CHANGELOG.md b/CHANGELOG.md
index c4d0fed..c589df7 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -13,6 +13,8 @@ and simply didn't have the time to go back and retroactively create one.
 - Fixed `ChannelFile.recvinto` which will no longer raise `BlockingIOError` (#126, #131)
 - Fixed sessions command with invalid session ID (#130)
 - Fixed zsh shell prompt color syntax (#130)
+- Added Pull Request template
+- Added CONTRIBUTING.md
 
 ## [0.4.1] - 2021-06-14
 ### Added
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0d6eb3e..39fa46a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -22,6 +22,27 @@ to do. We can't read your mind, and English isn't perfect. If you are
 interested in or willing to help implement your new feature, please explicitly
 let us know. This will help in prioritizing the issue.
 
+## Submitting Pull Requests
+
+When submitting a pull request, ensure you have read through and comply with
+these contributing rules. The pull request template should guide you through
+the things that need done before merging code.
+
+For help with running pre-merge tools, see the styling and formatting section
+below. For running pytest test cases, see the testing section.
+
+Before submitting your changes in a pull request, please add a brief one-line
+summary to the `CHANGELOG.md` file under the `[Unreleased]` heading. This makes
+releases more straightforward and bug fixes and features are added along the way.
+For information on the format of the changelog, see
+[Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+If you are submitting a bug fix, annotate this with `Fixes #XXX` replacing the
+`XXX` with the issue number. This ensures that the issue will be closed once
+the bug fix is merged. If your bug fix does not **completely** fix the issue,
+do not use the `Fixes` keyword. Instead, mention the issue by number in your
+pull request to ensure the link between the issue and pull request is clear.
+
 ## Versioning
 
 pwncat follows Semantic Versioning. You can learn about the basics of semver