From 2165fd4c6b972dbdd6380c0fc022c06c8bd44301 Mon Sep 17 00:00:00 2001 From: fed <58637860+fedddddd@users.noreply.github.com> Date: Tue, 4 Apr 2023 11:14:21 +0200 Subject: [PATCH] Add issue template --- .github/ISSUE_TEMPLATE/config.yml | 5 ++++ .github/ISSUE_TEMPLATE/get-help.md | 31 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/request-a-feature.md | 27 ++++++++++++++++++ 3 files changed, 63 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/get-help.md create mode 100644 .github/ISSUE_TEMPLATE/request-a-feature.md diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..8ea9700a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Discord Server + url: https://discord.gg/dpnRn2tKT9/ + about: Please ask and answer support questions here. diff --git a/.github/ISSUE_TEMPLATE/get-help.md b/.github/ISSUE_TEMPLATE/get-help.md new file mode 100644 index 00000000..1bcac1e2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/get-help.md @@ -0,0 +1,31 @@ +--- +name: Get help +about: Get help using H2-Mod +title: '' +labels: discussion +assignees: '' + +--- + +_Do not open an issue here if you need help with modding or have a problem getting the client to run. +It is very likely your problem will be resolved by reading the [README](https://github.com/fedddddd/h2-mod#installation) carefully. +Ask in the `#help` channel on the [Discord](https://discord.gg/dpnRn2tKT9) server if you still have problems. +Before opening a new issue, please see [Issues](https://github.com/fedddddd/h2-mod/issues) and check that a similar issue does not already exist +If this does not apply, please continue by filling in the template below._ + +**What are you trying to do?** +A short, concise description of the outcome you are trying to achieve. + +**What problem are you having?** +A clear and concise description of the problem that is blocking you from your desired outcome, ex. "H2-Mod is crashing with this error message: ..." +Please walk us through the steps you have taken when you encountered this problem. +If H2-Mod is crashing, include the minidump file and the crash address in text form. Screenshots showing the message box with the crash address are not acceptable. + +**What have you tried so far?** +Describe any steps you've already taken to try to get past this issue. Have you found a workaround? + +**What version of H2-Mod are you using?** +Please make sure you are up to date with the latest build from the `main` or `develop` branch. + +**Anything else we should know?** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/request-a-feature.md b/.github/ISSUE_TEMPLATE/request-a-feature.md new file mode 100644 index 00000000..167932aa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/request-a-feature.md @@ -0,0 +1,27 @@ +--- +name: Request a feature +about: Suggest a new feature or enhancement +title: '' +labels: feature +assignees: '' + +--- + +_Before opening a new feature request, please see [Issues](https://github.com/fedddddd/h2-mod/issues) and check that a similar issue does not already exist. +If this a new request, help us help you by filling in the template below. +H2-Mod is not in active development right now. Please keep in mind that if there is not a clear positive impact on the gameplay to be gained by this feature request, it may be closed at the maintainers' discretion._ + +**What problem will this solve?** +A clear and concise description of the problem this new feature is meant to solve, ex. "There is something wrong with the game" or "There is something wrong with H2-Mod's source code". +Please limit your request to a single feature; create multiple feature requests instead. + +**What might be a solution?** +A clear and concise description of what you want to happen. If you are proposing changes to H2-Mod's source code, tell us which component you want to be changed. +If you propose changes to the game, you may use images or videos to illustrate what aspect of the game should be changed. + +**What other alternatives have you already considered?** +A clear and concise description of any alternative solutions or features you've considered. +It may help others to find workarounds until the problem is resolved. + +**Anything else we should know?** +Add any other context or screenshots about the feature request here.