Add issue and PR templates

widelands · Nov 29, 2024 · 623ed6c · 623ed6c
1 parent f3286e4
commit 623ed6c
Show file tree

Hide file tree

Showing 4 changed files with 269 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report_addon.yml b/.github/ISSUE_TEMPLATE/bug_report_addon.yml
@@ -0,0 +1,108 @@
+name: Bug Report (Add-On)
+description: Report a bug in an add-on.
+labels: bug
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please note that add-ons are not maintained by the Widelands Development Team.
+        The responsibility for fixing bugs in an add-on lies with the add-on's author.
+        Issues here will be forwarded to the author, but there is no guarantee that the author will address the issue.
+
+  - type: input
+    id: addon-name
+    attributes:
+      label: Add-On Name
+      description: The add-on this bug report is about.
+      placeholder: e.g. "europeans_main.wad", "Frisians Economy Ultra"
+    validations:
+      required: true
+
+  - type: input
+    id: addon-version
+    attributes:
+      label: Add-On Version
+      description: The version of the add-on.
+      placeholder: e.g. "v1.9.4", "v2.2.2"
+    validations:
+      required: true
+
+  - type: textarea
+    id: summary
+    attributes:
+      label: Describe the Bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: To Reproduce
+      description: Steps to reproduce the behavior
+      value: |
+        1. Go to '…'
+        2. Click on '…'
+        3. Scroll down to '…'
+        4. Error: …
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: If applicable, add screenshots to help explain your problem.
+
+  - type: textarea
+    id: replays
+    attributes:
+      label: Replays
+      description: If applicable, include a replay demonstrating the problem or leading to a crash.
+
+  - type: textarea
+    id: savegames
+    attributes:
+      label: Savegames
+      description: If applicable, include a savegame demonstrating the problem or helping to reproduce it.
+
+  - type: input
+    id: os-version
+    attributes:
+      label: Operating System
+      description: The version of the operating system.
+      placeholder: e.g. "Ubuntu 24.04", "Windows 11 64-bit"
+    validations:
+      required: true
+
+  - type: input
+    id: wl-version
+    attributes:
+      label: Widelands Version
+      description: The version of Widelands.
+      placeholder: e.g. "v1.2", "73f9eb5c0b26599b72609f3e27de569f49049269"
+    validations:
+      required: true
+
+  - type: textarea
+    id: addons-versions
+    attributes:
+      label: Enabled Add-Ons
+      description: All enabled add-ons
+      placeholder: e.g. "frisians-economy-ultra.wad", "Frisians Economy Ultra"
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Add any other context about the problem here.
+
diff --git a/.github/ISSUE_TEMPLATE/bug_report_server.yml b/.github/ISSUE_TEMPLATE/bug_report_server.yml
@@ -0,0 +1,78 @@
+name: Bug Report (Server)
+description: Create a report to help us fix a bug in the server.
+labels: bug, server
+
+body:
+  - type: textarea
+    id: summary
+    attributes:
+      label: Describe the Bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: To Reproduce
+      description: Steps to reproduce the behavior
+      value: |
+        1. Go to '…'
+        2. Click on '…'
+        3. Scroll down to '…'
+        4. Error: …
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: log
+    attributes:
+      label: Logs
+      description: Relevant log output from the server.
+      render: text
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: If applicable, add screenshots to help explain your problem.
+
+  - type: input
+    id: java-version
+    attributes:
+      label: Java Version
+      description: The version of the Java compiler and runtime.
+      placeholder: e.g. "OpenJDK 21, Oracle Java 17"
+    validations:
+      required: true
+
+  - type: input
+    id: server-version
+    attributes:
+      label: Server Version
+      description: The version of the server.
+      placeholder: e.g. "f3286e4181f360f40f52e05c845670753f0810e6"
+    validations:
+      required: true
+
+  - type: input
+    id: wl-version
+    attributes:
+      label: Widelands Version
+      description: The version of the Widelands client.
+      placeholder: e.g. "v1.2", "73f9eb5c0b26599b72609f3e27de569f49049269"
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Add any other context about the problem here.
+
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,47 @@
+name: Feature Request
+description: Suggest an idea for this project.
+labels: enhancement
+
+body:
+  - type: textarea
+    id: summary
+    attributes:
+      label: Describe the Problem
+      description: A clear and concise description of what the problem is.
+      placeholder: e.g. I'm always frustrated when …
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Solution
+      description: Describe the solution you'd like
+      placeholder: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives
+      description: Describe any alternative solutions or features you've considered.
+      placeholder: A clear and concise description of any alternative solutions or features you've considered.
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Add any other context about the feature request here.
+
+  - type: textarea
+    id: implementation
+    attributes:
+      label: Implementation Steps
+      description: How this feature might be implemented.
+      placeholder: |
+        - [ ] Define protocol changes
+        - [ ] Define database changes
+        - [ ] Add server changes
+        - [ ] Add engine changes
+
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,36 @@
+<!-- Please fill out the relevant sections below and delete the rest. -->
+
+### Type of Change
+Bugfix / New feature / Refactoring / …
+
+### Issue(s) Closed
+Fixes #…
+
+If the bug/feature does not appear on the issue tracker: a clear and concise description of what your change does *and why it is desirable*.
+
+### To Reproduce
+<!-- *If it's a bugfix:* Steps to reproduce the behavior which cause the bug in master but not in your branch: -->
+1. Go to '…'
+2. Click on '…'
+3. Scroll down to '….'
+4. See error
+
+### New Behavior
+<!-- A clear and concise description of what happens with your change. -->
+
+
+### How it Works
+<!-- *For features and functional changes:* A clear and concise description how to make use of the feature in practice. -->
+
+
+### Possible Regressions
+<!-- Descriptions of other bugs this change might conceivably introduce or reopen. -->
+
+
+### Screenshots
+<!-- If applicable, add screenshots to help explain the feature. -->
+
+
+### Additional context
+<!-- Add any other context about the problem here. -->
+