From 3b7fac68d3ca6b95c7464144632114d8ece6fb40 Mon Sep 17 00:00:00 2001
From: Disconnect3d <Dominik.Czarnota@fis.agh.edu.pl>
Date: Fri, 21 Apr 2017 23:01:29 +0200
Subject: [PATCH] Add CONTRIBUTING and ISSUE_TEMPLATE (#238)

---
 .github/CONTRIBUTING.md   | 31 +++++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE.md | 41 +++++++++++++++++++++++++++++++++++++++
 README.md                 |  4 +++-
 3 files changed, 75 insertions(+), 1 deletion(-)
 create mode 100644 .github/CONTRIBUTING.md
 create mode 100644 .github/ISSUE_TEMPLATE.md

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 000000000..d6771698b
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,31 @@
+### Contributing
+
+Contributions to Pwndbg are always welcome!
+
+If you want to help, fork the project, hack your changes and create a pull request.
+
+If this is something big/new feature or a bug, consider creating an issue first.
+
+
+Some guides:
+* [Fork a project](https://help.github.com/articles/fork-a-repo/)
+* [Pull requests](https://help.github.com/articles/about-pull-requests/)
+
+### Versioning and releases
+
+* There are three branches: `stable`, `beta` and `dev`
+* Each developer works on his own fork
+* Only bug-fixes will be merged into either `stable` or `beta`
+* Every release, merges are cascaded `stable -> beta -> dev`
+* After merging, a new minor-point-release (`1.X`) is created for `stable`
+* Releases occur on predetermined schedule
+* Bugs _are not fixed_ on releases older than the current `stable` (i.e. `0.9` is never fixed)
+* Mid-cycle releases get a patch version bump (`1.1.X`) when bugs affecting `stable` or `beta` are found
+* Pull requests which fix bugs target the oldest branch they affect (e.g. `stable`).
+* There might be occassional cherry-picks if something is fixed in a later branch and we don't notice/forget that it should really target an earlier branch.
+* Documentation fixes, travis fixes, CHANGELOG/README fixes and other tiny fixes does not trigger a new point release.
+
+### Contact
+
+If you want to talk with other contributors and pwndbg users 
+join us at our irc channel: #pwndbg at freenode.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 000000000..dda3e71e7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,41 @@
+<!--
+Before reporting a new issue, make sure that we do not have any duplicates already open.
+If there is one it might be good to take part in the discussion there.
+
+Please make sure you have checked that the issue persists on LATEST pwndbg version.
+
+Below is a template for BUG REPORTS.
+Don't include it if this is a FEATURE REQUEST.
+-->
+
+
+### Description
+
+<!--
+Briefly describe the problem you are having in a few paragraphs.
+-->
+
+### Steps to reproduce
+
+<!--
+What do we have to do to reproduce the problem?
+If this is connected to particular C/asm code, 
+please provide the smallest C code that reproduces the issue.
+-->
+
+### My setup
+
+<!--
+Show us your gdb/python/pwndbg/OS/IDA Pro version (depending on your case).
+
+NOTE: We are currently supporting only Ubuntu installations.
+It is known that pwndbg is not fully working e.g. on Arch Linux (the heap stuff is not working there).
+If you would like to change this situation - help us improving pwndbg and supporting other distros!
+
+This can be displayed in pwndbg through `version` command.
+
+If it is somehow unavailable, use:
+* `show version` - for gdb
+* `py import sys; print(sys.version)` - for python
+* pwndbg version/git commit id
+-->
\ No newline at end of file
diff --git a/README.md b/README.md
index fe4ffc1bd..a194be908 100644
--- a/README.md
+++ b/README.md
@@ -40,7 +40,9 @@ For further info about features/functionalities, see [FEATURES](FEATURES.md).
 
 Most of Pwndbg was written by [Zach Riggle](https://twitter.com/ebeip90), with [many other contributors](https://github.com/pwndbg/pwndbg/graphs/contributors) offering up patches via Pull Requests.
 
+Want to help with development? Read [CONTRIBUTING](.github/CONTRIBUTING.md).
+
 ## Contact
 If you have any questions not worthy of a [bug report](https://github.com/pwndbg/pwndbg/issues), feel free to ping
-at [`ebeip90` on Freenode](irc://irc.freenode.net/pwndbg) and ask away.
+[`ebeip90` at #pwndbg on Freenode](irc://irc.freenode.net/pwndbg) and ask away.
 Click [here](https://kiwiirc.com/client/irc.freenode.net/pwndbg) to connect.