Add direct feedback capability (#45)

* Add feedback button * Change feedback button text * Bump version * Add yaml issue and discussion templates * Appease MegaLinter * Adapt ProgramNameAndVersion UT * Add issue labeler for selected tool * Add new line buttons to AboutView * Remove whitespace flagged by linter * Fix typos * Fix more linter complaints * Fix more/new linter errors * Rename GitHub btn * Add test to ensure URL is unchanged * (try to) fix some Linter-complaints * more "lint for yaml"-fixes * one more linter-fix --------- Co-authored-by: ptahmose <[email protected]>
ZEISS · Dec 7, 2023 · 9a727b0 · 9a727b0
1 parent 3e4dc8d
commit 9a727b0
Show file tree

Hide file tree

Showing 18 changed files with 337 additions and 100 deletions.
diff --git a/.github/DISCUSSION_TEMPLATE/czi-compress-feature-requests.yml b/.github/DISCUSSION_TEMPLATE/czi-compress-feature-requests.yml
@@ -0,0 +1,26 @@
+---
+labels: ["czicompress", "enhancement"]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: Is your feature request related to a problem? Please describe.
+      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when...
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false
diff --git a/.github/DISCUSSION_TEMPLATE/czi-compress-feedback.yml b/.github/DISCUSSION_TEMPLATE/czi-compress-feedback.yml
@@ -0,0 +1,16 @@
+---
+labels: ["czicompress", "feedback"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for your interest in CZI Compress!
+
+        Your feedback helps us improve 💪
+  - type: textarea
+    id: content
+    attributes:
+      label: Feedback
+      description: Tell us your thoughts!
+    validations:
+      required: true
diff --git a/.github/DISCUSSION_TEMPLATE/czi-compress-questions.yml b/.github/DISCUSSION_TEMPLATE/czi-compress-questions.yml
@@ -0,0 +1,10 @@
+---
+labels: ["czicompress", "question"]
+body:
+  - type: textarea
+    id: question
+    attributes:
+      label: Question
+      description: Please add any screenshots or logs if applicable
+    validations:
+      required: true
diff --git a/.github/DISCUSSION_TEMPLATE/czi-shrink-feature-requests.yml b/.github/DISCUSSION_TEMPLATE/czi-shrink-feature-requests.yml
@@ -0,0 +1,26 @@
+---
+labels: ["czishrink", "enhancement"]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: Is your feature request related to a problem? Please describe.
+      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when...
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false
diff --git a/.github/DISCUSSION_TEMPLATE/czi-shrink-feedback.yml b/.github/DISCUSSION_TEMPLATE/czi-shrink-feedback.yml
@@ -0,0 +1,16 @@
+---
+labels: ["czishrink", "feedback"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for your interest in CZI Shrink!
+
+        Your feedback helps us improve 💪
+  - type: textarea
+    id: content
+    attributes:
+      label: Feedback
+      description: Tell us your thoughts!
+    validations:
+      required: true
diff --git a/.github/DISCUSSION_TEMPLATE/czi-shrink-questions.yml b/.github/DISCUSSION_TEMPLATE/czi-shrink-questions.yml
@@ -0,0 +1,10 @@
+---
+labels: ["czishrink", "question"]
+body:
+  - type: textarea
+    id: question
+    attributes:
+      label: Question
+      description: Please add any screenshots or logs if applicable
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,76 @@
+---
+name: "🕷️ Bug report"
+description: Create a report to help us improve
+labels:
+ - bug
+body:
+ - type: dropdown
+   id: toolaffected
+   attributes:
+    label: Which tool is affected?
+    description: CZI Shrink is the GUI application while CZI Compress refers to the CLI tool.
+    multiple: false
+    options:
+     - CZI Compress
+     - CZI Shrink
+   validations:
+    required: true
+
+ - type: textarea
+   attributes:
+    label: Description
+    description: Describe the bug and add screenshots if possible/applicable.
+    placeholder: A clear and concise description of what the bug is.
+   validations:
+    required: true
+
+ - type: textarea
+   attributes:
+    label: Steps to reproduce
+    description: Please include screenshots (if applicable) and relevant logs.
+    placeholder: |
+      1. Go to '...'
+      2. Click on '....'
+      3. Scroll down to '....'
+      4. See error
+   validations:
+    required: true
+
+ - type: textarea
+   attributes:
+    label: Expected behavior
+    description: A clear and concise description of what you expected to happen.
+    placeholder: |
+      1. Go to '...'
+      2. Click on '....'
+      3. Scroll down to '....'
+      4. See error
+   validations:
+    required: true
+
+ - type: dropdown
+   attributes:
+    label: OS
+    description: What operating system are you using?
+    multiple: false
+    options:
+     - Windows
+     - MacOS
+     - Linux
+   validations:
+    required: true
+
+ - type: input
+   attributes:
+    label: OS Version
+    description: What version and flavor (if applicable) of your OS are you using?
+    placeholder: Ubuntu 23.10 | Sonoma 14.1.2 | Windows 11 23H2
+   validations:
+    required: true
+
+ - type: textarea
+   attributes:
+    label: Other Context
+    description: Please add any other context that may be relevant.
+   validations:
+    required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,21 @@
+---
+blank_issues_enabled: false
+contact_links:
+  - name: "\U0000270D CZI Shrink Feedback"
+    url: https://github.com/ZEISS/czicompress/discussions/new?category=czi-shrink-feedback
+    about: Feedback for the GUI tool CZI Shrink
+  - name: "\U0001F4A1 CZI Shrink Feature Request"
+    url: https://github.com/ZEISS/czicompress/discussions/new?category=czi-shrink-feature-requests
+    about: Feature request for the GUI tool CZI Shrink
+  - name: "\U0000003F CZI Shrink Questions"
+    url: https://github.com/ZEISS/czicompress/discussions/new?category=czi-shrink-questions
+    about: Questions about the GUI tool CZI Shrink
+  - name: "\U0000270D CZI Compress Feedback"
+    url: https://github.com/ZEISS/czicompress/discussions/new?category=czi-compress-feedback
+    about: Feedback for the CLI tool CZI Compress
+  - name: "\U0001F4A1 CZI Compress Feature Request"
+    url: https://github.com/ZEISS/czicompress/discussions/new?category=czi-compress-feature-requests
+    about: Feature request for the CLI tool CZI Compress
+  - name: "\U0000003F CZI Compress Questions"
+    url: https://github.com/ZEISS/czicompress/discussions/new?category=czi-compress-questions
+    about: Questions about the CLI tool CZI Compress
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
diff --git a/.github/advanced-issue-labeler.yml b/.github/advanced-issue-labeler.yml
@@ -0,0 +1,10 @@
+---
+policy:
+  - section:
+      - id: [toolaffected]
+        block-list: ['None', 'Other']
+        label:
+          - name: czicompress
+            keys: ['CZI Compress']
+          - name: 'czishrink'
+            keys: ['CZI Shrink']
diff --git a/.github/workflows/issue_labeler.yml b/.github/workflows/issue_labeler.yml
@@ -0,0 +1,30 @@
+---
+name: Bug issue labeler
+on:
+  issues:
+    types: [opened]
+
+permissions:
+  contents: read
+
+jobs:
+  label-component:
+    runs-on: ubuntu-latest
+
+    permissions:
+      issues: write
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Parse issue form
+        uses: stefanbuck/github-issue-parser@c1a559d78bfb8dd05216dab9ffd2b91082ff5324
+        id: issue-parser
+        with:
+          template-path: .github/ISSUE_TEMPLATE/bug_report.yml
+
+      - name: Set labels based on toolaffected field
+        uses: redhat-plumbers-in-action/advanced-issue-labeler@v2
+        with:
+          issue-form: ${{ steps.issue-parser.outputs.jsonString }}
+          token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/czishrink/Directory.Build.props b/czishrink/Directory.Build.props
@@ -17,6 +17,6 @@
 
     <!-- Version -->
     <IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion>
-    <VersionPrefix>1.1.6<!--bugfix/timespan_format_greater_than_24h_addendum--></VersionPrefix>
+    <VersionPrefix>1.2.0<!--feature/add-feedback-button--></VersionPrefix>
   </PropertyGroup>
 </Project>
diff --git a/czishrink/netczicompress/ViewModels/AboutViewModel.cs b/czishrink/netczicompress/ViewModels/AboutViewModel.cs
@@ -24,6 +24,7 @@ public AboutViewModel(IFileLauncher launcher, IProgramNameAndVersion info)
         this.CloseAboutCommand = ReactiveCommand.Create(() => this.IsVisible = false);
         this.ShowAboutCommand = ReactiveCommand.Create(() => this.IsVisible = true);
         this.ShowTextFileCommand = ReactiveCommand.CreateFromTask<string>(this.OpenTextFile);
+        this.OpenUrlCommand = ReactiveCommand.CreateFromTask<string>(this.OpenUrlLink);
         this.ProgramVersionAndCopyRight = $"{info}, © 2023 Carl Zeiss Microscopy GmbH and others";
         this.launcher = launcher;
     }
@@ -41,9 +42,16 @@ public AboutViewModel(IFileLauncher launcher, IProgramNameAndVersion info)
 
     public ICommand ShowTextFileCommand { get; }
 
+    public ICommand OpenUrlCommand { get; }
+
     private Task OpenTextFile(string filename)
     {
         var fullFilename = System.IO.Path.Combine(AppContext.BaseDirectory, filename);
         return this.launcher.Launch(fullFilename);
     }
+
+    private Task OpenUrlLink(string url)
+    {
+        return this.launcher.Launch(url);
+    }
 }
diff --git a/czishrink/netczicompress/ViewModels/IAboutViewModel.cs b/czishrink/netczicompress/ViewModels/IAboutViewModel.cs
@@ -18,4 +18,6 @@ public interface IAboutViewModel
     string LibraryName { get; }
 
     ICommand ShowTextFileCommand { get; }
+
+    ICommand OpenUrlCommand { get; }
 }