✨ Add issue templates for bug reports, feature requests, and quick issues (#85)

ScreepCode · web-flow · commit 02ddabe4ea7e · 2025-04-06T13:50:46.000+02:00
This pull request includes the addition of new issue and pull request
templates to improve the process of reporting bugs, requesting features,
and creating issues in MoveTopia. The most important changes include the
creation of detailed templates for bug reports, feature requests, and
quick issues, as well as the addition of a pull request template.

New issue templates:

*
[`.github/ISSUE_TEMPLATE/bug_report.yml`](diffhunk://#diff-637f7b97bba458badb691a1557c3d4648686292e948dbe3e8360564378b653efR1-R103):
Added a comprehensive bug report template to capture detailed
information about bugs, including steps to reproduce, expected behavior,
platform, and version details.
*
[`.github/ISSUE_TEMPLATE/feature_request.yml`](diffhunk://#diff-c6b098646bf32c644234bec14c2675ea2a3d9c2dc2df450a25aa0e7ff02323cdR1-R59):
Added a feature request template to collect detailed descriptions of new
ideas, motivations, user experience, and alternatives.
*
[`.github/ISSUE_TEMPLATE/minimal_issue.yml`](diffhunk://#diff-77fd0e38fe0935bb6aba06aa29c2713df2a53fb6a7f9ecb0ac9ebf670f5dbb76R1-R46):
Added a minimal issue template for quick and simple issues, capturing a
brief description, context, and priority.

Configuration and contact information:

*
[`.github/ISSUE_TEMPLATE/config.yml`](diffhunk://#diff-1c0d972ee49103af56fd608a77a28e1eb12f6908f263f0f183d46868fdcd8ea2R1-R11):
Enabled blank issues and added contact links for the MoveTopia website,
support email, and community support.

New pull request template:

*
[`.github/PULL_REQUEST_TEMPLATE/pull_request_template.md`](diffhunk://#diff-45659dae3c8acfb7058b31c52c8600ca9c72a11a482372feea9ab85cb0f270faR1-R17):
Added a pull request template to standardize the information provided in
pull requests, including brief descriptions, linked issues, screenshots,
and GitHub Copilot suggestions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,103 @@
+name: 🐞 Bug Report
+description: Report a bug in MoveTopia
+title: "[BUG] "
+labels: [ "bug" ]
+assignees: [ ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to report a bug in MoveTopia!
+
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: 🔍 Bug Description
+      description: Describe the bug clearly and precisely
+      placeholder: When I try to...
+    validations:
+      required: true
+
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: 🪜 Steps to Reproduce
+      description: Tell us how to reproduce this issue
+      placeholder: |
+        1. Open the app
+        2. Navigate to...
+        3. Click on...
+        4. Observe the error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: 🎬 Expected Behavior
+      description: What should actually happen?
+      placeholder: The app should...
+    validations:
+      required: true
+
+  - type: dropdown
+    id: platform
+    attributes:
+      label: 📱 Platform
+      description: On which platform does this occur?
+      multiple: true
+      options:
+        - iOS
+        - Android
+        - All platforms
+    validations:
+      required: true
+
+  - type: input
+    id: app-version
+    attributes:
+      label: App Version
+      description: What version of MoveTopia are you using?
+      placeholder: e.g. 2025.04.06.0
+    validations:
+      required: true
+
+  - type: input
+    id: device
+    attributes:
+      label: Device
+      description: What device are you using?
+      placeholder: e.g. iPhone 14 Pro, Samsung Galaxy S22
+    validations:
+      required: false
+
+  - type: input
+    id: os-version
+    attributes:
+      label: Operating System Version
+      description: What OS version are you using?
+      placeholder: e.g. iOS 16.5, Android 13
+    validations:
+      required: false
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: 📸 Screenshots
+      description: If possible, add screenshots to help explain your problem
+      placeholder: Drag and drop images here
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: 📝 Additional Information
+      description: Any other helpful information
+    validations:
+      required: false
+
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for helping to improve MoveTopia! 
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,11 @@
+blank_issues_enabled: true
+contact_links:
+  - name: 🌐 MoveTopia Website
+    url: https://movetopia.de
+    about: Visit our website for more information about MoveTopia
+  - name: 📧 Support Email
+    url: mailto:mail@movetopia.de
+    about: Contact our support team directly via email
+  - name: 💬 MoveTopia Community Support
+    url: https://github.com/ScreepCode/MoveTopia/discussions
+    about: Discussions and help for the MoveTopia App
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,59 @@
+name: 💡 Feature Request
+description: Suggest a new idea for MoveTopia
+title: "[FEATURE] "
+labels: ["enhancement"]
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to suggest a new feature for MoveTopia!
+  
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: 🌟 Feature Description
+      description: Describe your idea clearly and precisely
+      placeholder: I'd like to see...
+    validations:
+      required: true
+  
+  - type: textarea
+    id: motivation
+    attributes:
+      label: 🎯 Motivation
+      description: Why should we add this feature? What problem does it solve?
+      placeholder: This feature would help with...
+    validations:
+      required: true
+      
+  - type: textarea
+    id: user-experience
+    attributes:
+      label: 📱 User Experience
+      description: How do you envision the interaction with this feature?
+      placeholder: Users would be able to...
+    validations:
+      required: false
+      
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: 🧩 Alternatives
+      description: Have you considered any alternatives?
+      placeholder: Another approach could be...
+    validations:
+      required: false
+      
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: 📝 Additional Information
+      description: Any other relevant information or context
+    validations:
+      required: false
+      
+  - type: markdown
+    attributes:
+      value: |
+        <!-- Fun fact: MoveTopia gets a little better every day! --> 
diff --git a/.github/ISSUE_TEMPLATE/minimal_issue.yml b/.github/ISSUE_TEMPLATE/minimal_issue.yml
@@ -0,0 +1,46 @@
+name: 🔧 Quick Issue
+description: Create a simple issue with minimal details
+title: ""
+labels: []
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Use this form for quick and simple issues.
+  
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: What needs to be done?
+      placeholder: Briefly describe what needs attention...
+    validations:
+      required: true
+      
+  - type: textarea
+    id: context
+    attributes:
+      label: Context
+      description: Any additional information needed?
+      placeholder: Add any relevant context...
+    validations:
+      required: false
+      
+  - type: dropdown
+    id: priority
+    attributes:
+      label: Priority
+      description: How urgent is this issue?
+      options:
+        - Low
+        - Medium
+        - High
+        - Critical
+    validations:
+      required: false
+      
+  - type: markdown
+    attributes:
+      value: |
+        ℹ️ For more detailed templates, see our bug report and feature request options 
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -0,0 +1,17 @@
+# 🚀 Pull Request
+
+## Brief Description
+<!-- Briefly describe what these changes accomplish -->
+
+## Linked Issues
+<!-- Link related issues with the format: Fixes #123, Resolves #456, Closes #1337 -->
+- 
+
+## Screenshots
+<!-- Add screenshots if UI changes were made. Either new screens only or before/after -->
+| Screen 1 | Screen 2 |
+|----------|----------|
+|          |          |
+
+## GitHub Copilot Text
+<!-- GitHub Copilot can suggest a PR description here -->
diff --git a/.github/workflows/build-android-debug.yml b/.github/workflows/build-android-debug.yml
@@ -6,8 +6,66 @@ on:
   workflow_dispatch:
 
 jobs:
+  check-skip-conditions:
+    runs-on: ubuntu-latest
+    outputs:
+      skip-build: ${{ steps.check-labels.outputs.skip_build }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Check PR labels
+        id: check-labels
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const { execSync } = require('child_process');
+            
+            // Get the last commit message
+            const lastCommitMsg = execSync('git log -1 --pretty=format:%s').toString().trim();
+            console.log(`Last commit message: ${lastCommitMsg}`);
+            
+            // Check if this is a PR merge commit
+            const prMergeRegex = /Merge pull request #(\d+) from/;
+            const prMatch = lastCommitMsg.match(prMergeRegex);
+            
+            if (!prMatch) {
+              console.log('Not a PR merge commit, proceeding with build');
+              core.setOutput('skip_build', 'false');
+              return;
+            }
+            
+            const prNumber = prMatch[1];
+            console.log(`PR number: ${prNumber}`);
+            
+            // Get PR details from GitHub API
+            try {
+              const { data: pr } = await github.rest.pulls.get({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                pull_number: parseInt(prNumber)
+              });
+              
+              const labels = pr.labels || [];
+              const skipLabels = ['docs-only', 'no-build'];
+              const shouldSkip = labels.some(label => skipLabels.includes(label.name));
+              
+              console.log(`Labels: ${labels.map(l => l.name).join(', ')}`);
+              console.log(`Should skip build: ${shouldSkip}`);
+              
+              core.setOutput('skip_build', shouldSkip.toString());
+            } catch (error) {
+              console.error(`Error fetching PR #${prNumber}: ${error.message}`);
+              core.setOutput('skip_build', 'false');
+            }
+          result-encoding: string
+
   build-debug:
     name: "Build Debug APK"
+    needs: check-skip-conditions
+    if: ${{ needs.check-skip-conditions.outputs.skip-build == 'false' }}
     runs-on: ubuntu-latest
     steps:
       - name: "Checkout repository"
diff --git a/.github/workflows/pr-check.yml b/.github/workflows/pr-check.yml
@@ -7,8 +7,28 @@ on:
   workflow_dispatch:
 
 jobs:
+  check-skip-conditions:
+    runs-on: ubuntu-latest
+    outputs:
+      skip-build: ${{ steps.check-labels.outputs.skip_build }}
+    steps:
+      - name: Check PR labels
+        id: check-labels
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const labels = context.payload.pull_request?.labels || [];
+            const skipLabels = ['docs-only', 'no-build'];
+            const shouldSkip = labels.some(label => skipLabels.includes(label.name));
+            console.log(`Labels: ${labels.map(l => l.name).join(', ')}`);
+            console.log(`Should skip build: ${shouldSkip}`);
+            core.setOutput('skip_build', shouldSkip.toString());
+          result-encoding: string
+
   build-check:
     name: "Build Check"
+    needs: check-skip-conditions
+    if: ${{ needs.check-skip-conditions.outputs.skip-build == 'false' }}
     runs-on: ubuntu-latest
     steps:
       - name: "Checkout repository"
