summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <github@jplamondonw.com>2018-07-11 12:19:04 -0400
committerJesse Plamondon-Willard <github@jplamondonw.com>2018-07-11 12:19:04 -0400
commite71cfc63b5be6b0665d5da86bfa9c63eb3c02e9a (patch)
tree1acefdb19e18cc19ed61821da0ae8ed167215e1a /.github
parent1b1e89ebc5efc40c07d7a69daa455851f98baa96 (diff)
downloadSMAPI-e71cfc63b5be6b0665d5da86bfa9c63eb3c02e9a.tar.gz
SMAPI-e71cfc63b5be6b0665d5da86bfa9c63eb3c02e9a.tar.bz2
SMAPI-e71cfc63b5be6b0665d5da86bfa9c63eb3c02e9a.zip
add GitHub issue templates
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md19
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md32
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md15
-rw-r--r--.github/ISSUE_TEMPLATE/general.md15
-rw-r--r--.github/SUPPORT.md5
5 files changed, 86 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 00000000..052cec2c
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,19 @@
+Do you want to...
+
+* **Ask for help using SMAPI?**
+ Please post a message in the [SMAPI support thread](http://community.playstarbound.com/threads/108375)
+ or [ask on Discord](https://stardewvalleywiki.com/Modding:Community#Discord), don't create a
+ GitHub issue.
+
+* **Report a bug?**
+ Please post a message in the [SMAPI support thread](http://community.playstarbound.com/threads/108375)
+ or [ask on Discord](https://stardewvalleywiki.com/Modding:Community#Discord) instead, unless
+ you're sure it's a bug in SMAPI itself.
+
+* **Submit a pull request?**
+ Pull requests are welcome! If you're submitting a new feature, it's best to discuss first to make
+ sure it'll be accepted. Feel free to come chat in [#modding on Discord](https://stardewvalleywiki.com/Modding:Community#Discord)
+ or post in the [SMAPI support thread](http://community.playstarbound.com/threads/108375).
+
+ Documenting your code and using the same formatting conventions is appreciated, but don't worry too
+ much about it. We'll fix up the code after we accept the pull request if needed.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000..7b5d5a6f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Report a problem with SMAPI.
+
+---
+
+<!--
+
+Only report a bug here if you're sure it's a SMAPI bug! To request support instead, see:
+ - #modding on Discord: https://stardewvalleywiki.com/Modding:Community#Discord
+ - support forum thread: https://community.playstarbound.com/threads/108375
+ - Nexus mod page: https://www.nexusmods.com/stardewvalley/mods/2400
+
+Replace the instructions below with the bug details.
+
+-->
+
+**Describe the bug**
+A clear and concise description of what the bug is. Provide any other details you think might be relevant here.
+
+**To Reproduce**
+Exact steps which reproduce the bug, if possible. For example:
+1. Load save '...'.
+2. Walk to '....'.
+3. Click '....'.
+4. Error occurs.
+
+**Log file**
+Upload your SMAPI log to https://log.smapi.io and post a link here.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 00000000..3f671ccc
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,15 @@
+---
+name: Feature request
+about: Suggest an idea for SMAPI.
+
+---
+
+<!--
+
+GitHub issues are only used for development tasks. Please don't submit feature requests here! Instead, see...
+
+ - #modding on Discord: https://stardewvalleywiki.com/Modding:Community#Discord
+ - support forum thread: https://community.playstarbound.com/threads/108375
+ - Nexus page: https://www.nexusmods.com/stardewvalley/mods/2400
+
+-->
diff --git a/.github/ISSUE_TEMPLATE/general.md b/.github/ISSUE_TEMPLATE/general.md
new file mode 100644
index 00000000..00c31305
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/general.md
@@ -0,0 +1,15 @@
+---
+name: General
+about: Create a ticket about something else.
+
+---
+
+<!--
+
+GitHub issues are only used for development tasks. For support and questions, see...
+
+ - #modding on Discord: https://stardewvalleywiki.com/Modding:Community#Discord
+ - support forum thread: https://community.playstarbound.com/threads/108375
+ - Nexus page: https://www.nexusmods.com/stardewvalley/mods/2400
+
+-->
diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md
new file mode 100644
index 00000000..757aadee
--- /dev/null
+++ b/.github/SUPPORT.md
@@ -0,0 +1,5 @@
+GitHub issues are only used for SMAPI development tasks.
+
+To get help with SMAPI problems, you can...
+* [ask on Discord](https://stardewvalleywiki.com/Modding:Community#Discord);
+* or post in the [SMAPI support thread](https://community.playstarbound.com/threads/108375).