Merge pull request #203 from Spartan322/add/issue-templates

Add issue templates

5 files changed, 226 insertions, 0 deletions

diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml
new file mode 100644
index 0000000..ed65db1
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/1-bug-report.yml
@@ -0,0 +1,78 @@
+name: Bug Report
+description: "File a bug report. NOTE: Not for reporting distinctions from Victoria II."
+labels: ["bug", "needs triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for filling out this bug report!
+
+        When reporting a bug, please follow the guidelines in this template. This helps us quickly identify the problem you're having.
+        - If this report is about a feature or behavior in Victoria II that is missing or working incorrectly in OpenVic, please report a [Victoria II discrepency](https://github.com/OpenVicProject/OpenVic/issues/new?assignees=&labels=&projects=&template=2-victoria-2-discrepency.yml) instead.
+        - Write a descriptive issue title above.
+        - **Always open *one* issue for *one* bug**. If you notice several bugs, make sure to create one new issue for each of them.
+        - Verify that you are using either the latest release or the latest commit. It is preferred that you check if your issue is reproducible in the latest commit - it may already have been fixed!
+        - If you're playing with custom source modifications, please test if your bug is reproducible in the latest official build of OpenVic before opening an issue here.
+
+  - type: checkboxes
+    attributes:
+      label: Duplicate Issue?
+      description: "Search [open](https://github.com/OpenVicProject/OpenVic/issues) and [closed](https://github.com/OpenVicProject/OpenVic/issues?q=is%3Aissue+is%3Aclosed) issues to ensure it has not already been reported. If you don't find a relevant match or if you're not sure, don't hesitate to **open a new issue**. Contributors will handle it from there if it's a duplicate."
+      options:
+      - label: I have checked for an existing bug report.
+        required: true
+
+  - type: textarea
+    id: game-versions
+    attributes:
+      label: Game & Version Info
+      description: |
+        Enter the OpenVic version and commit you found the bug on in this box. You can find and copy this by clicking on the "Game Info" button in the bottom left corner of the OpenVic main menu. If you've found this bug to be reproducible on multiple versions, list all of those versions here.
+      placeholder: |
+        - Found in: <v0.02_Mappa_Mundi> (c65b2a795fd35e81f7a1906d07d15c47cd94cf9c).
+        - Not reproducible in: <v0.01_Primum_Mobile> (1980012045ea4c6b314d6d12a796eda23ae8d7fa).
+    validations:
+      required: true
+
+  - type: textarea
+    id: modlist
+    attributes:
+      label: Mods or Extensions used
+      description: |
+        If you used any mods or extensions, please list them here with the version and a link to each mod/extension.
+
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Issue Description
+      description: |
+        Describe your issue briefly. What doesn't work, and how do you expect it to work instead?
+        You can include images or videos with drag and drop.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: Steps to Reproduce
+      description: |
+        List of steps that reproduces the issue. Having reproducible issues is a prerequisite for contributors to be able to solve them.
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant Log Output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+
+  - type: checkboxes
+    id: os
+    attributes:
+      label: "Operating System"
+      description: "Select the Operating System you found the bug under. If you've tested multiple and reproduced the bug, you can select more than one."
+      options:
+        - label: Windows 11
+        - label: macOS
+        - label: Linux
diff --git a/.github/ISSUE_TEMPLATE/2-victoria-2-discrepency.yml b/.github/ISSUE_TEMPLATE/2-victoria-2-discrepency.yml
new file mode 100644
index 0000000..e56b91e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/2-victoria-2-discrepency.yml
@@ -0,0 +1,53 @@
+name: Victoria II Discrepency
+description: "Report a discrepency from Victoria II. NOTE: Not for reporting bugs in OpenVic."
+labels: ["bug", "victoria 2 discrepency", "needs triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for filling out this discrepency report!
+
+        When reporting a bug, please follow the guidelines in this template. This helps us quickly identify the discrepency and get to work on a solution.
+        - Only open this issue if you have noticed a difference between OpenVic and Victoria II.
+        - **DO NOT FILE CRASHES HERE!** Please use the [bug report](https://github.com/OpenVicProject/OpenVic/issues/new?assignees=&labels=&projects=&template=1-bug-report.yml) template instead.
+        - Write a descriptive issue title above.
+        - **Always open *one* issue for *one* discrepency**. If you notice several discrepencies, make sure to create one new issue for each of them.
+        - Verify that you are using either the latest release or the latest commit. It is preferred that you check if your issue is reproducible in the latest commit - it may already have been fixed!
+        - If you're playing with custom source modifications, please test if this discrepency is reproducible in the latest official build of OpenVic before opening an issue here.
+
+  - type: checkboxes
+    attributes:
+      label: Duplicate Issue?
+      description: "Search [open](https://github.com/OpenVicProject/OpenVic/issues) and [closed](https://github.com/OpenVicProject/OpenVic/issues?q=is%3Aissue+is%3Aclosed) issues to ensure it has not already been reported. If you don't find a relevant match or if you're not sure, don't hesitate to **open a new issue**. Contributors will handle it from there if it's a duplicate."
+      options:
+      - label: I have checked for an existing discrepency report.
+        required: true
+
+  - type: textarea
+    id: game-versions
+    attributes:
+      label: Game & Version Info
+      description: |
+        Enter the OpenVic version and commit you found this discrepency on in this box. You can find and copy this by clicking on the "Game Info" button in the bottom left corner of the OpenVic main menu. If you've found this discrepency to be reproducible on multiple versions, list all of those versions here.
+      placeholder: |
+        - Found in: <v0.02_Mappa_Mundi> (c65b2a795fd35e81f7a1906d07d15c47cd94cf9c).
+        - Not reproducible in: <v0.01_Primum_Mobile> (1980012045ea4c6b314d6d12a796eda23ae8d7fa).
+    validations:
+      required: true
+
+  - type: textarea
+    id: modlist
+    attributes:
+      label: Mods or Extensions used
+      description: |
+        If you used any mods or extensions, please list them here with the version and a link to each mod/extension.
+
+  - type: textarea
+    id: discrepency-description
+    attributes:
+      label: Issue Description
+      description: |
+        Describe the discrepency briefly. What happens in OpenVic, and how does it work in Victoria II?
+        You can include images or videos with drag and drop.
+    validations:
+      required: true
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/3-gameplay-feature-request.yml b/.github/ISSUE_TEMPLATE/3-gameplay-feature-request.yml
new file mode 100644
index 0000000..533146d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/3-gameplay-feature-request.yml
@@ -0,0 +1,27 @@
+name: Gameplay Feature Request
+description: Request a gameplay feature
+labels: ["enhancement", "game feature proposal", "needs triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        - If this feature was in Victoria II, please report a [Victoria II Discrepency](https://github.com/OpenVicProject/OpenVic/issues/new?assignees=&labels=&projects=&template=2-victoria-2-discrepency.yml) instead.
+        - If this feature only applies to mods and contains no mechanical additions to the vanilla experience, please report it as a [mod feature request](https://github.com/OpenVicProject/OpenVic/issues/new?assignees=&labels=&projects=&template=4-mod-feature-request.yml).
+        - Write a descriptive proposal title above.
+
+  - type: checkboxes
+    attributes:
+      label: Duplicate Proposal?
+      description: "Search [open](https://github.com/OpenVicProject/OpenVic/issues) and [closed](https://github.com/OpenVicProject/OpenVic/issues?q=is%3Aissue+is%3Aclosed) proposals to ensure this feature has not already been proposed. If there is a match, you can bump it or leave a comment with your ideas and concerns. If you don't find a relevant match or if you're not sure, don't hesitate to **open a new issue**. Contributors will handle it from there if it's a duplicate."
+      options:
+      - label: I have checked for an existing feature request.
+        required: true
+
+  - type: textarea
+    id: feature-proposal
+    attributes:
+      label: Feature Description
+      description: An in-depth description of what feature you want added to OpenVic, and **why** its important to have.
+      placeholder: Example - "Add a macro builder - a menu that allows you to contruct armies or navies from templates. Think of the macro builder menu from EUIV perhaps. This will improve the game experience by allowing people to build whole armies at once rather than counting out brigades in the army build menu."
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/4-mod-feature-request.yml b/.github/ISSUE_TEMPLATE/4-mod-feature-request.yml
new file mode 100644
index 0000000..f965af7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/4-mod-feature-request.yml
@@ -0,0 +1,62 @@
+name: Mod Feature Request
+description: Request a feature for the sake of mods
+labels: ["enhancement", "mod feature proposal", "needs triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        - If this feature was in Victoria II, please report a [Victoria II discrepency](https://github.com/OpenVicProject/OpenVic/issues/new?assignees=&labels=&projects=&template=2-victoria-2-discrepency.yml) instead.
+        - If this feature only intends to include mechanical additions to the vanilla experience, please report it as a [gameplay feature request](https://github.com/OpenVicProject/OpenVic/issues/new?assignees=&labels=&projects=&template=3-gameplay-feature-request.yml).
+        - Write a descriptive proposal title above.
+
+  - type: checkboxes
+    attributes:
+      label: Duplicate Proposal?
+      description: "Search [open](https://github.com/OpenVicProject/OpenVic/issues) and [closed](https://github.com/OpenVicProject/OpenVic/issues?q=is%3Aissue+is%3Aclosed) proposals to ensure this feature has not already been proposed. If there is a match, you can bump it or leave a comment with your ideas and concerns. If you don't find a relevant match or if you're not sure, don't hesitate to **open a new issue**. Contributors will handle it from there if it's a duplicate."
+      options:
+      - label: I have checked for an existing feature request.
+        required: true
+
+  - type: dropdown
+    id: mod-type
+    attributes:
+      label: Purpose
+      description: |
+        For what purpose does this request seek to serve?
+      options:
+        - Mods
+        - Source Code Extensions
+      default: 0
+    validations:
+      required: true
+
+  - type: textarea
+    id: feature-dependent-mod
+    attributes:
+      label: Project
+      description: If you need this for a specific modding project, specify above. This is important so that we know the *context* in which the feature is being proposed. Features used in real projects are more likely to be added.
+      placeholder: Example - "A cold war overhaul mod"
+
+  - type: textarea
+    attributes:
+      label: Problem
+      description: Describe the problem or limitation within OpenVic you are running into in your project.
+      placeholder: Example - "Victoria II's modding script doesn't have a traditional if statement, which makes our code more roundabout and less readable."
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Solution
+      description: Describe the feature / enhancement you're proposing and how it helps to overcome the problem or limitation you're running into.
+      placeholder: Example - "Add an if statement to OpenVic, so that we don't have to use if-emulation, and can clean up and simplify our code."
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Existing Workaround?
+      description: If this enhancement will not be used often, can it be worked around with a few lines of script?
+      placeholder: Example - "This can be worked around, but it is not particularly convenient."
+    validations:
+      required: true
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..55afd23
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,6 @@
+blank_issues_enabled: true
+
+contact_links:
+  - name: OpenVic Community
+    url:  https://discord.gg/vM4E3BFkqH
+    about: Please ask for technical support on the community Discord server, not here.
\ No newline at end of file