diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8f0c7b7a03..1f4ad1a55d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -45,6 +45,8 @@ Before you submit your pull request consider the following guidelines: * Search [GitHub](https://github.com/runelite/runelite/pulls) for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort. +* If adding a feature or enhancement, we recommend you first [start a discussion for + it](https://github.com/runelite/runelite/discussions) before submitting a Pull Request. * [Fork](https://help.github.com/articles/fork-a-repo/) this repo. * [Clone](https://help.github.com/articles/cloning-a-repository/) your copy. ```shell diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md deleted file mode 100644 index 219706327f..0000000000 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: "\U0001F41B Bug report" -about: Create a report to help us improve - ---- - -Please check if your issue is not a duplicate by [searching existing issues](https://github.com/runelite/runelite/search?type=Issues) - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Environment (please complete the following information):** - - OS: [e.g. Windows, Ubuntu, macOS] - - RuneLite version: [e.g 1.4.6] - - Launcher version: [e.g 1.5.2] - -**Additional context** -Add any other context about the problem here, e.g. logs. Your client logs can usually be found in -`C:\Users\\.runelite\logs` on Windows and `~/.runelite/logs` on Linux and macOS. diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md deleted file mode 100644 index 57cf66a8dd..0000000000 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: "\U0001F680 Feature Request" -about: Suggest an idea for this project - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always -frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've -considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/bug-issue.yml b/.github/ISSUE_TEMPLATE/bug-issue.yml new file mode 100644 index 0000000000..2a1a89575b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-issue.yml @@ -0,0 +1,74 @@ +name: Bug Report +description: Report a clearly broken issue. +labels: ["needs-triage"] +body: + - type: markdown + attributes: + value: | + # RuneLite bug report + + Before filing a bug report, please check whether your issue has been reported before: + - Read the pinned issues (if any) at the top of https://github.com/runelite/runelite/issues. + - Search for your issue in both [the issue listing](https://github.com/runelite/runelite/issues) and the [Q&A discussion listing](https://github.com/runelite/runelite/discussions/categories/q-a). If you find that it already exists, respond with a reaction or add any further information that may be helpful. + - type: dropdown + attributes: + label: Type + options: + - Crash or hang + - Incorrect behavior + - Performance + - GPU + - Other + validations: + required: true + - type: dropdown + attributes: + label: Operating System + options: + - Windows + - MacOS + - Linux + validations: + required: false + - type: input + attributes: + label: OS Version + description: Version information for your operating system, ex. Windows 11, MacOS Big Sur, Ubuntu Linux, etc. + validations: + required: false + - type: textarea + attributes: + label: Bug description + description: How did you find the bug? Any additional details that might help? + validations: + required: true + - type: textarea + attributes: + label: Screenshots or videos + description: Add screenshots or videos that show the bug here. + validations: + required: false + - type: textarea + attributes: + label: RuneLite version + description: RuneLite and launcher version used. (Open the info panel to find this information) + placeholder: | + RuneLite version: 1.8.18.1 + Launcher version: 2.4.2 + - type: markdown + attributes: + value: | + ## Logs + + Attaching log files is encouraged for reported bugs. You can find them in one of two ways: + + 1. Open the screenshot directory (by right-clicking the \"Camera\" button if you have access to the client) and navigate one directory up and then open logs folder + 2. Navigate to `%userprofile%\.runelite\logs` on **Windows** or `$HOME/.runelite/logs` on **Linux** and **MacOS** + + You should upload both your `client.log` and `launcher.log` files, along with recently-created `jvm_crash_pid` files if this bug report is regarding the client crashing. + - type: textarea + attributes: + label: Logs + placeholder: Drag and drop log files into this box. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..6cde237beb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Suggestion or feature request + url: https://github.com/runelite/runelite/discussions/categories/ideas + about: Got an idea of something which should be changed or added? Search for or start a new discussion! + - name: Help + url: https://github.com/runelite/runelite/discussions/categories/q-a + about: Need support or think you've encountered a bug? Check the Q&A section!