Iatr/clean

.github/ISSUE_TEMPLATE/01-app-bug-report.yml

@@ -0,0 +1,121 @@
+# HMS Networks; Americas
+# Application Bug Report Template for Maven-based Ewon ETK Projects
+# Version: 3.0.1
+# Date: June 6, 2024
+#
+# Changes (v3.0.1): Replaced references to 'Application' with 'Library'
+#
+# This template provides an option when creating a new issue to report an
+# application bug using a structured format.
+
+name: Bug Report
+description: Create a new bug report to help us improve the project.
+title: "[BUG] <title>"
+labels: [ 'bug' ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please provide a clear and concise description of the bug you are experiencing.
+  - type: checkboxes
+    attributes:
+      label: 'Do I have the latest version of the Ewon firmware?'
+      description: 'Library updates and patches are tested using latest version of the Ewon firmware at the time of release.'
+      options:
+        - label: 'Yes'
+          required: true
+  - type: checkboxes
+    attributes:
+      label: 'Do I have the latest version of the library?'
+      description: 'Some bugs may have been fixed in the latest version of the library.'
+      options:
+        - label: 'Yes'
+          required: true
+  - type: dropdown
+    attributes:
+      label: 'Do I have a custom or modified version of the library?'
+      description: 'Some bugs may be specific to custom or modified versions of the library.'
+      options:
+        - 'No'
+        - 'Yes'
+    validations:
+      required: true
+  - type: input
+    id: firmware-version
+    attributes:
+      label: 'Ewon Firmware Version'
+      description: 'The version of the Ewon firmware you are using.'
+      placeholder: 'e.g. 14.8s0'
+    validations:
+      required: true
+  - type: input
+    id: library-version
+    attributes:
+      label: 'Library Version'
+      description: 'The version of the library you are using.'
+      placeholder: 'e.g. 1.0.0'
+    validations:
+      required: true
+  - type: dropdown
+    id: network-connection-type
+    attributes:
+      label: 'Network Connection Type'
+      description: 'The type of network connection you are using.'
+      options:
+        - 'Ethernet'
+        - 'Wi-Fi'
+        - 'Cellular'
+        - 'Other/Unsure'
+    validations:
+      required: true
+  - type: textarea
+    id: current-behavior
+    attributes:
+      label: 'Current Behavior'
+      description: 'A clear and concise description of what is currently happening. Please include any error messages or logs.'
+      placeholder: 'I was trying to do X, but Y happened instead.'
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: 'Expected Behavior'
+      description: 'A clear and concise description of what you expected to happen.'
+      placeholder: 'I expected X to happen.'
+    validations:
+      required: true
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: 'Steps to Reproduce'
+      description: 'Please provide detailed steps to reproduce the bug.'
+      placeholder: '1. Go to "..."'
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        If this issue is not easily reproducible, please take a backup of your Ewon including support files.
+        To better diagnose the issue, it is important that the backup be taken while the issue is occurring, or as soon as possible after the issue occurs.
+        If requested, be prepared to provide this backup to HMS Networks support.
+  - type: textarea
+    id: additional-information
+    attributes:
+      label: 'Additional Information'
+      description: 'Please provide any additional information that may be helpful in diagnosing the bug.'
+      placeholder: 'I have tried X, Y, and Z to fix the issue, but nothing has worked.'
+  - type: checkboxes
+    id: code-of-conduct
+    attributes:
+      label: 'Code of Conduct'
+      description: 'By submitting this issue, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).'
+      options:
+        - label: 'I agree to abide by the Code of Conduct.'
+          required: true
+  - type: markdown
+    attributes:
+      value: |
+        <h5>Privacy Notice</h5>
+        This form creates a GitHub issue in the repository for this project, which may be publicly accessible or shared with third parties.
+        Please do not include any sensitive information, including device backup files.
+        Sensitive information should be provided to HMS Networks Support when requested.

.github/ISSUE_TEMPLATE/02-doc-issue-report.yml

@@ -0,0 +1,48 @@
+# HMS Networks; Americas
+# Documentation Issue Report Template for Maven-based Ewon ETK Projects
+# Version: 3.0.0
+# Date: February 8, 2024
+#
+# This template provides an option when creating a new issue to report an
+# error or mistake in the documentation using a structured format.
+
+name: Documentation Issue Report
+description: Create a new documentation issue report to help us improve the project.
+title: "[DOC] <title>"
+labels: [ 'documentation' ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please provide a clear and concise description of the documentation issue or mistake you have found.
+  - type: input
+    id: page-url
+    attributes:
+      label: 'Page URL'
+      description: 'The URL of the documentation page where the issue or mistake is located.'
+      placeholder: 'e.g. https://hms-networks.github.io/sc-java-maven-starter-project/docs'
+    validations:
+      required: true
+  - type: input
+    id: issue-description
+    attributes:
+      label: 'Issue Description'
+      description: 'A clear and concise description of the issue or mistake you have found.'
+      placeholder: 'e.g. The code example on this page is incorrect.'
+    validations:
+      required: true
+  - type: checkboxes
+    id: code-of-conduct
+    attributes:
+      label: 'Code of Conduct'
+      description: 'By submitting this issue, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).'
+      options:
+        - label: 'I agree to abide by the Code of Conduct.'
+          required: true
+  - type: markdown
+    attributes:
+      value: |
+        <h5>Privacy Notice</h5>
+        This form creates a GitHub issue in the repository for this project, which may be publicly accessible or shared with third parties.
+        Please do not include any sensitive information, including device backup files.
+        Sensitive information should be provided to HMS Networks Support when requested.

.github/ISSUE_TEMPLATE/03-feature-request.yml

@@ -0,0 +1,59 @@
+# HMS Networks; Americas
+# Feature/Enhancement Request Template for Maven-based Ewon ETK Projects
+# Version: 3.0.0
+# Date: February 8, 2024
+#
+# This template provides an option when creating a new issue to report a
+# feature or enhancement request using a structured format.
+
+name: Feature or Enhancement Request
+description: Create a request for a new feature or enhancement in the project.
+title: "[FEATURE] <title>"
+labels: [ 'enhancement' ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please provide a clear and concise description of the feature or enhancement you are requesting.
+  - type: checkboxes
+    attributes:
+      label: 'Is this feature or enhancement request related to a problem?'
+      description: 'Please provide a clear and concise description of what the problem is. Ex. I am always frustrated when [...]'
+      options:
+        - label: 'Yes'
+          required: true
+  - type: textarea
+    id: feature-enhancement-description
+    attributes:
+      label: 'Feature/Enhancement Description'
+      description: 'A clear and concise description of what the feature or enhancement is.'
+      placeholder: 'e.g. I would like to see [...]'
+    validations:
+      required: true
+  - type: textarea
+    id: feature-enhancement-alternatives
+    attributes:
+      label: 'Feature/Enhancement Alternatives'
+      description: 'A clear and concise description of any alternative solutions or features you have considered.'
+      placeholder: 'e.g. I have considered [...]'
+  - type: textarea
+    id: additional-information
+    attributes:
+      label: 'Additional Information'
+      description: 'Please provide any additional information that may be helpful.'
+      placeholder: 'e.g. The feature or enhancement may also help with [...]'
+  - type: checkboxes
+    id: code-of-conduct
+    attributes:
+      label: 'Code of Conduct'
+      description: 'By submitting this feature/enhancement request, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).'
+      options:
+        - label: 'I agree to abide by the Code of Conduct.'
+          required: true
+  - type: markdown
+    attributes:
+      value: |
+        <h5>Privacy Notice</h5>
+        This form creates a GitHub issue in the repository for this project, which may be publicly accessible or shared with third parties.
+        Please do not include any sensitive information, including device backup files.
+        Sensitive information should be provided to HMS Networks Support when requested.

.github/ISSUE_TEMPLATE/04-security-report.yml

@@ -0,0 +1,68 @@
+# HMS Networks; Americas
+# Security Report Template for Maven-based Ewon ETK Projects
+# Version: 3.0.1
+# Date: June 6, 2024
+#
+# Changes (v3.0.1): Replaced references to 'Application' with 'Library'
+#
+# This template provides an option when creating a new issue to report a
+# security issue or concern using a structured format. This template is not
+# intended for reporting security vulnerabilities. Security vulnerabilities
+# should be reported at https://www.hms-networks.com/cybersecurity.
+
+name: Security Report
+description: Create a new security report to help us improve the project.
+title: "[SECURITY] <title>"
+labels: [ 'bug', 'needs investigation' ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please provide a clear and concise description of the security issue or concern.
+        If you believe this is a security vulnerability, please do not disclose it here.
+        Security vulnerabilities should be reported at https://www.hms-networks.com/cybersecurity.
+  - type: input
+    id: library-version
+    attributes:
+      label: 'Library Version'
+      description: 'The version of the library you are using.'
+      placeholder: 'e.g. 1.0.0'
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: 'Description'
+      description: 'A clear and concise description of the security issue or concern.'
+      placeholder: 'e.g. When I do X, Y, and Z, the application does A, B, and C.'
+    validations:
+      required: true
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: 'Steps to Reproduce'
+      description: 'Please provide detailed steps to reproduce the security issue or concern.'
+      placeholder: '1. Go to "..."'
+    validations:
+      required: true
+  - type: textarea
+    id: additional-information
+    attributes:
+      label: 'Additional Information'
+      description: 'Please provide any additional information that may be helpful.'
+      placeholder: 'I have tried X, Y, and Z to address the security issue or concern, but nothing has worked.'
+  - type: checkboxes
+    id: code-of-conduct
+    attributes:
+      label: 'Code of Conduct'
+      description: 'By submitting this report, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).'
+      options:
+        - label: 'I agree to abide by the Code of Conduct.'
+          required: true
+  - type: markdown
+    attributes:
+      value: |
+        <h5>Privacy Notice</h5>
+        This form creates a GitHub issue in the repository for this project, which may be publicly accessible or shared with third parties.
+        Please do not include any sensitive information, including device backup files.
+        Sensitive information should be provided to HMS Networks Support when requested.

.github/ISSUE_TEMPLATE/05-other-report.yml

@@ -0,0 +1,73 @@
+# HMS Networks; Americas
+# Other/Unknown Report Template for Maven-based Ewon ETK Projects
+# Version: 3.0.1
+# Date: June 6, 2024
+#
+# Changes (v3.0.1): Replaced references to 'Application' with 'Library'
+#
+# This template provides an option when creating a new issue to report an
+# unknown or other issue using a structured format.
+
+name: Other Report
+description: Create a new report to help us improve the project.
+title: "[OTHER] <title>"
+labels: [ 'help wanted', 'needs investigation' ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please provide a clear and concise description of the report you are submitting.
+  - type: dropdown
+    attributes:
+      label: 'Do I have a custom or modified version of the library?'
+      description: 'Some questions or concerns may be specific to custom or modified versions of the library.'
+      options:
+        - 'No'
+        - 'Yes'
+    validations:
+      required: true
+  - type: input
+    id: firmware-version
+    attributes:
+      label: 'Ewon Firmware Version'
+      description: 'The version of the Ewon firmware you are using.'
+      placeholder: 'e.g. 14.8s0'
+    validations:
+      required: true
+  - type: input
+    id: library-version
+    attributes:
+      label: 'Library Version'
+      description: 'The version of the library you are using.'
+      placeholder: 'e.g. 1.0.0'
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: 'Description'
+      description: 'A clear and concise description of the report you are submitting.'
+      placeholder: 'e.g. What is occurring? Is there an issue or concern?'
+    validations:
+      required: true
+  - type: textarea
+    id: information
+    attributes:
+      label: 'Additional Information'
+      description: 'Please provide any additional information that may be helpful.'
+      placeholder: 'e.g. The issue or concern is causing X, Y, and Z.'
+  - type: checkboxes
+    id: code-of-conduct
+    attributes:
+      label: 'Code of Conduct'
+      description: 'By submitting this report, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).'
+      options:
+        - label: 'I agree to abide by the Code of Conduct.'
+          required: true
+  - type: markdown
+    attributes:
+      value: |
+        <h5>Privacy Notice</h5>
+        This form creates a GitHub issue in the repository for this project, which may be publicly accessible or shared with third parties.
+        Please do not include any sensitive information, including device backup files.
+        Sensitive information should be provided to HMS Networks Support when requested.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: HMS Networks Support
+    url: https://support.hms-networks.com/hc/en-us
+    about: Please contact our support team for assistance.
+  - name: HMS Networks Cybersecurity
+    url: https://www.hms-networks.com/cybersecurity
+    about: Please report security vulnerabilities here.