diff --git a/.github/ISSUE_TEMPLATE/accuracy_bug_report.yaml b/.github/ISSUE_TEMPLATE/accuracy_bug_report.yaml new file mode 100644 index 00000000..a0e7de2f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/accuracy_bug_report.yaml @@ -0,0 +1,60 @@ +name: Accuracy bug report +description: Create a bug report to help us fix incorrect wordings +labels: ["bug: accuracy"] +body: + - type: markdown + attributes: + value: | + Thank you for reporting an issue. + Please try to fill in as much of the form below as you're able to. Some of the fields marked with an asterisk (*) are required. + - type: checkboxes + id: version + attributes: + label: Check version + options: + - label: I'm running the latest version of Path of Building and I've verified this by checking the [changelog](https://github.com/PathOfBuildingCommunity/PathOfBuilding/blob/master/CHANGELOG.md) + required: true + - type: checkboxes + id: duplicates + attributes: + label: Check for duplicates + options: + - label: I've checked for duplicate issues by using the search function of the [issue tracker](https://github.com/PathOfBuildingCommunity/PathOfBuilding/issues) + required: true + - type: textarea + id: expected + attributes: + label: What is the wording ingame? + description: Please write a clear and concise description of what should happen. + placeholder: | + E.g. when I look at the unique [...] ingame it says [...]. + [screenshot]. + validations: + required: true + - type: textarea + id: actual + attributes: + label: What is the wording in Path of Building? + description: Please write a clear and concise description of what actually happens. + placeholder: | + E.g. When I look at the unique [...] in Path of Building it says [...]. + [screenshot]. + validations: + required: true + - type: textarea + id: build_code + attributes: + label: Character build code + description: Always provide a build code that exhibits the bug you want to report, even if it is not specific to a particular build. This helps us greatly to reproduce bugs faster. + placeholder: This can be either a code copied from the "Import/Export Build" tab or a link to a shared build. + render: shell + validations: + required: false + - type: textarea + id: context + attributes: + label: Screenshots + description: Always provide screenshots of the problematic wording if possible. GIFs or short videos are also okay, if the bug cannot be displayed in a still image. + placeholder: In this text area, you can attach files/images (copy paste) directly, or link to them if they're hosted elsewhere instead. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/application_bug_report.yaml similarity index 73% rename from .github/ISSUE_TEMPLATE/bug_report.yaml rename to .github/ISSUE_TEMPLATE/application_bug_report.yaml index 63fe203f..8415dd8b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/application_bug_report.yaml @@ -1,5 +1,5 @@ -name: Bug report -description: Create a bug report to help us improve +name: Application Bug report +description: Create a bug report to help us fix an issue in path of building labels: [bug] body: - type: markdown @@ -24,27 +24,27 @@ body: - type: textarea id: expected attributes: - label: What is the expected behaviour/value? + label: How is Path of Building expected to behave? description: Please write a clear and concise description of what should happen. - placeholder: E.g. When I'm clicking on [...], I expect [...]. + placeholder: E.g. When I resize PoB all [...] should be accessible. validations: required: true - type: textarea id: actual attributes: - label: What is the actual behaviour/value? + label: How does Path of Building behave? description: Please write a clear and concise description of what actually happens. - placeholder: E.g. When I'm hovering over [...], PoB displays [...]. + placeholder: E.g. When I resize PoB some [...] become inaccessible. validations: required: true - type: textarea - id: alternatives + id: steps attributes: label: How to reproduce the issue description: Please provide step-by-step instructions. placeholder: | E.g. - 1. Select [...] as main skill. + 1. Select [...] as the main skill. 2. Switch to the items tab. 3. Remove the main skill group. 4. [...]. @@ -58,12 +58,12 @@ body: placeholder: This can be either a code copied from the "Import/Export Build" tab or a link to a shared build. render: shell validations: - required: true + required: false - type: textarea id: context attributes: label: Screenshots - description: If you receive an error or experience graphical bugs, include one or multiple screenshots. GIFs or short videos are also okay, if the bug cannot be displayed in a still image. - placeholder: In this text area, you can attach files directly or link to them if they're hosted elsewhere instead. + description: Always provide screenshots of the problem if possible. GIFs or short videos are also okay, if the bug cannot be displayed in a still image. + placeholder: In this text area, you can attach files/images (copy paste) directly, or link to them if they're hosted elsewhere instead. validations: required: false diff --git a/.github/ISSUE_TEMPLATE/behaviour_bug_report.yaml b/.github/ISSUE_TEMPLATE/behaviour_bug_report.yaml new file mode 100644 index 00000000..fe451783 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/behaviour_bug_report.yaml @@ -0,0 +1,75 @@ +name: Behaviour bug report +description: Create a bug report to help us fix incorrectly behaviour or logic +labels: ["bug: behaviour"] +body: + - type: markdown + attributes: + value: | + Thank you for reporting an issue. + Please try to fill in as much of the form below as you're able to. Some of the fields marked with an asterisk (*) are required. + - type: checkboxes + id: version + attributes: + label: Check version + options: + - label: I'm running the latest version of Path of Building and I've verified this by checking the [changelog](https://github.com/PathOfBuildingCommunity/PathOfBuilding/blob/master/CHANGELOG.md) + required: true + - type: checkboxes + id: duplicates + attributes: + label: Check for duplicates + options: + - label: I've checked for duplicate issues by using the search function of the [issue tracker](https://github.com/PathOfBuildingCommunity/PathOfBuilding/issues) + required: true + - type: checkboxes + id: validity + attributes: + label: Check for support + options: + - label: I've checked that the behaviour is supposed to be supported. If it isn't please open a feature request instead (Red text is a feature request). + required: true + - type: textarea + id: expected + attributes: + label: What is the behaviour ingame? + description: Please write a clear and concise description of what should happen. + placeholder: E.g. Ingame something behaves in a certain way. e.g. curse priority, auras disabled by mod, skills triggered in a certain way, etc. + validations: + required: true + - type: textarea + id: actual + attributes: + label: What is the behaviour in Path of Building? + description: Please write a clear and concise description of what actually happens. + placeholder: E.g. In Path of Building something behaves incorrectly e.g. incorrect curse priority, auras not disabled by mod, skill not triggered correctly, etc. + validations: + required: true + - type: textarea + id: steps + attributes: + label: How to reproduce the issue + description: Please provide step-by-step instructions. + placeholder: | + E.g. + 1. Add [...] skill. + 2. Switch to the calcs tab. + 3. See incorrect [...] applied. + validations: + required: false + - type: textarea + id: build_code + attributes: + label: Character build code + description: Always provide a build code that exhibits the bug you want to report, even if it is not specific to a particular build. This helps us greatly to reproduce bugs faster. + placeholder: This can be either a code copied from the "Import/Export Build" tab or a link to a shared build. + render: shell + validations: + required: true + - type: textarea + id: context + attributes: + label: Screenshots + description: Always provide screenshots of the problematic behaviours if possible. GIFs or short videos are also okay, if the bug cannot be displayed in a still image. + placeholder: In this text area, you can attach files/images (copy paste) directly, or link to them if they're hosted elsewhere instead. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/calculation_bug_report.yaml b/.github/ISSUE_TEMPLATE/calculation_bug_report.yaml new file mode 100644 index 00000000..840bd5e2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/calculation_bug_report.yaml @@ -0,0 +1,75 @@ +name: Calculation bug report +description: Create a bug report to help us fix incorrect calculations +labels: ["bug: calculation"] +body: + - type: markdown + attributes: + value: | + Thank you for reporting an issue. + Please try to fill in as much of the form below as you're able to. Some of the fields marked with an asterisk (*) are required. + - type: checkboxes + id: version + attributes: + label: Check version + options: + - label: I'm running the latest version of Path of Building and I've verified this by checking the [changelog](https://github.com/PathOfBuildingCommunity/PathOfBuilding/blob/master/CHANGELOG.md) + required: true + - type: checkboxes + id: duplicates + attributes: + label: Check for duplicates + options: + - label: I've checked for duplicate issues by using the search function of the [issue tracker](https://github.com/PathOfBuildingCommunity/PathOfBuilding/issues) + required: true + - type: checkboxes + id: validity + attributes: + label: Check for support + options: + - label: I've checked that the calculation is supposed to be supported. If it isn't please open a feature request instead (Red text is a feature request). + required: true + - type: textarea + id: expected + attributes: + label: What is the value from the calculation ingame? + description: Please write a clear and concise description of what should happen. + placeholder: E.g. Ingame when I [...] and use [...] I believe it should be calculated as [...] and so the value is [...]. + validations: + required: true + - type: textarea + id: actual + attributes: + label: What is the value from the calculation in Path of Building? + description: Please write a clear and concise description of what actually happens. + placeholder: E.g. In Path of Building when I [...] and use [...] Path of Building calculates it as [...] and produces the incorrect value [...]. + validations: + required: true + - type: textarea + id: steps + attributes: + label: How to reproduce the issue + description: Please provide step-by-step instructions. + placeholder: | + E.g. + 1. Select [...] as the main skill. + 2. Apply [...] buff. + 3. See incorrect [...]. + validations: + required: false + - type: textarea + id: build_code + attributes: + label: Character build code + description: Always provide a build code that exhibits the bug you want to report, even if it is not specific to a particular build. This helps us greatly to reproduce bugs faster. + placeholder: This can be either a code copied from the "Import/Export Build" tab or a link to a shared build. + render: shell + validations: + required: true + - type: textarea + id: context + attributes: + label: Screenshots + description: Always provide screenshots of the problematic calculations if possible. GIFs or short videos are also okay, if the bug cannot be displayed in a still image. + placeholder: In this text area, you can attach files/images (copy paste) directly, or link to them if they're hosted elsewhere instead. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/crash_report.yaml b/.github/ISSUE_TEMPLATE/crash_report.yaml new file mode 100644 index 00000000..e19fa8e8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/crash_report.yaml @@ -0,0 +1,69 @@ +name: Crash report +description: Create a crash report to help us fix critical issues +labels: [bug, crash] +body: + - type: markdown + attributes: + value: | + Thank you for reporting a crash or serve graphical issue. + Please try to fill in as much of the form below as you're able to. Some of the fields marked with an asterisk (*) are required. + - type: checkboxes + id: version + attributes: + label: Check version + options: + - label: I'm running the latest version of Path of Building and I've verified this by checking the [changelog](https://github.com/PathOfBuildingCommunity/PathOfBuilding/blob/master/CHANGELOG.md) + required: true + - type: checkboxes + id: duplicates + attributes: + label: Check for duplicates + options: + - label: I've checked for duplicate issues by using the search function of the [issue tracker](https://github.com/PathOfBuildingCommunity/PathOfBuilding/issues) + required: true + - type: textarea + id: context + attributes: + label: Screenshots of crash/graphical issue, version and options menu + description: If you received a crash or graphical bugs, include one or multiple screenshots. GIFs or short videos are also okay, if the issue cannot be displayed in a still image. + placeholder: In this text area, you can attach files/images (copy paste) directly, or link to them if they're hosted elsewhere instead. + validations: + required: true + - type: textarea + id: configuration + attributes: + label: What are your system specifications and configuration? + description: Please write a clear and concise description of your system details. + placeholder: | + E.g. + Operating System: Windows 10 + Graphics: Nvidia gtx 1060; Driver xxxx + File Path / File Permissions: e.g. non-ascii characters. + Other notable system configuration information: e.g. a certain app might be conflicting with Path of Building. + validations: + required: true + - type: textarea + id: steps + attributes: + label: How to reproduce the issue + description: Please provide step-by-step instructions. + placeholder: | + E.g. + 1. Select [...] as a main skill. + 2. Switch to the items tab. + 3. Remove the main skill group. + 4. [...]. + validations: + required: true + - type: textarea + id: build_code + attributes: + label: Character build code + description: Provide a build code if the crash/graphical issue is caused by a certain build. + placeholder: | + This can be either a code copied from the "Import/Export Build" tab or a link to a shared build. + In the case where Path of Building crashes/doesn't work on startup or when you open a build. + Go to your builds folder (default %userprofile%/Documents/Path of Building/Builds) and copy the problematic build's .xml contents into a pastebin and supply the link. + render: shell + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index a77e82f3..d14ed940 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -35,7 +35,7 @@ body: attributes: label: Describe alternatives you've considered description: Please write a clear and concise description of any alternative solutions or features you've considered. - placeholder: Currently, the same functionality can be achieved be combining [...] with [...]. + placeholder: Currently, the same functionality can be achieved by combining [...] with [...]. validations: required: false - type: textarea @@ -43,6 +43,6 @@ body: attributes: label: Additional context description: Add any other context or screenshots about the feature request here. - placeholder: In this text area, you can attach files directly, or link to them if they're hosted elsewhere instead. + placeholder: In this text area, you can attach files/images (copy paste) directly, or link to them if they're hosted elsewhere instead. validations: required: false diff --git a/.github/release.yml b/.github/release.yml index d199b8c5..85c286a8 100644 --- a/.github/release.yml +++ b/.github/release.yml @@ -12,18 +12,24 @@ changelog: - title: New to Path of Building labels: - enhancement + - title: Fixed Crashes + labels: + - crash - title: User Interface labels: - user-interface + - title: Fixed Calculations + labels: + - "bug: calculation" + - title: Fixed Behaviours + labels: + - "bug: behaviour" - title: Accuracy Improvements labels: - - bug:accuracy - - bug:behavior - - bug:calculation + - "bug: accuracy" - title: Fixed Bugs labels: - bug - - crash - title: Other changes labels: - - "*" + - "*" \ No newline at end of file