From e71cfc63b5be6b0665d5da86bfa9c63eb3c02e9a Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Wed, 11 Jul 2018 12:19:04 -0400 Subject: add GitHub issue templates --- .github/CONTRIBUTING.md | 19 ++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 32 +++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 15 +++++++++++++++ .github/ISSUE_TEMPLATE/general.md | 15 +++++++++++++++ .github/SUPPORT.md | 5 +++++ 5 files changed, 86 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/general.md create mode 100644 .github/SUPPORT.md (limited to '.github') 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. + +--- + + + +**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. + +--- + + 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. + +--- + + 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). -- cgit