Update issue templates

3 files changed, 71 insertions, 6 deletions

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..cfe9e82
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,38 @@
+## About the Project
+This is designed to be a straightforward, simple tool. At the moment, I'm not
+very interested in adding the ability to interact more heavily with
+stackexchange (such as answering or voting), but adding user authentication is
+not off the table.  The main priorities are:
+
+- **Portability**: namely, maintain the same level of support as
+[crossterm](https://github.com/crossterm-rs/crossterm)
+- **Speed**: the HTTP requests should be the only limiting factor
+- **Intuition**: any keybindings should be intuitive enough to guess (for VIM
+users anyway)
+
+## Getting Started
+Familiarize yourself with both
+[crossterm](https://github.com/crossterm-rs/crossterm)
+and
+[cursive](https://github.com/gyscos/Cursive)
+since much of the application code is written against those libraries. In
+particular it would be helpful to be able to recognize when a bug is coming from
+this application or one of those underlying libraries.
+
+## Bugs
+
+When filing an issue, please mention the OS, the terminal, the offending CLI
+arguments, and add accompanying screenshots if applicable.
+
+## Features
+
+As long as your feature request fits with the priorities above, feel free to add
+the suggestion.
+
+## Pull Requests
+
+I'm still new to Rust, so I definitely welcome any refactoring contributions! I
+just ask that you also include an explanation for such changes. Of course, help
+with bugs and approved features is also much appreciated. Just make sure you've
+formatted code with [rustfmt](https://github.com/rust-lang/rustfmt). Sooner or
+later this will be added to the CI testing.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..b0a357b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. CLI arguments (including defaults):
+2. TUI input:
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment**
+ - OS:
+ - Terminal:
+ - `so --version`: 
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/README.md b/README.md
index 0f368d2..d6b1dfa 100644
--- a/README.md
+++ b/README.md
@@ -176,12 +176,12 @@ See more information about this choice
 [here](https://github.com/gyscos/cursive/wiki/Backends).
 
 ## contributing
-This was my first time writing Rust and I want to put out a **warning** that
-there is very likely some non-idiomatic and straight up ugly code throughout
-this project, so don't come looking here for a good Rust example! That being
-said, I would love to improve the codebase so if you have any refactoring
-contributions feel free to send me a PR, but please also add a short
-explanation.
+**Warning**: this was my first time writing Rust and there is very likely some
+non-idiomatic and straight up ugly code throughout this project, so don't come
+looking here for a good Rust example! That being said, I would love to improve
+the codebase. Feel free to check out the [contributing
+guidelines](.github/CONTRIBUTING.md) and submit any refactoring issues or pull
+requests.
 
 ## credits
 Credit to my good friend [Charles](heyitscharles.com) for logo design.