To Cinoteck

.gitattributes

@@ -24,6 +24,8 @@
 *.coffee   text
 *.css      text
 gradlew    text eol=lf
+.env       text eol=lf
+.env.example text eol=lf
 *.htm      text
 *.html     text
 *.inc      text

.github/ISSUE_TEMPLATE/BUG-REPORT.yml

@@ -0,0 +1,89 @@
+name: 1 - Bug Report
+description: Report an error or malfunction you encountered while using SORMAS.
+labels: 'bug'
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for reporting a bug you found in SORMAS! **Please make sure that your issue complies to our [Contributing guidelines](https://github.com/sormas-foundation/SORMAS-Project/blob/development/docs/CONTRIBUTING.md)** before submitting it. Note that bugs in the current development version that are not reproducible on a released version should generally be reported on the issue they have been introduced in.
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Bug Description
+      description: Describe the problematic behavior, i.e. what exactly happened, where it happened and under which circumstances. Provide as many details as possible, even if they might seem irrelevant to you. **If you have access to the server logs, attach relevant log output in a .txt file here** as this helps us to identify the source of the error. Please don't copy and paste server logs directly unless they are very short. Also, if possible, attach at least one screenshot depicting the problem (without exposing any protected data).
+      placeholder: You can attach server logs and screenshots by clicking this area to highlight it and then dragging them in.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: Reproduction Steps
+      description: Provide step-by-step instructions of how you triggered this bug, i.e. the order of actions you performed before the problem occurred. This helps us to reproduce it on our systems.
+      placeholder: |
+        1.
+        2.
+        ...
+      value: |
+        1.
+        2.
+        ...
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected Behavior
+      description: Shortly describe what you think should have happened instead of the reported behavior if the problem is the result of a misbehavior of the application that results in an unexpected outcome.
+    validations:
+      required: false
+  - type: dropdown
+    id: affected-area
+    attributes:
+      label: Affected Area(s)
+      description: Did you encounter this bug in the web app, Android app, or by using the ReST interface? You can select multiple values.
+      multiple: true
+      options:
+        - Web app
+        - Android app
+        - ReST API
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: SORMAS Version
+      description: Which version or versions of the software have you encountered this bug in?
+      placeholder: e.g. SORMAS 1.81.0
+    validations:
+      required: true
+  - type: input
+    id: android-browser
+    attributes:
+      label: Android version/Browser
+      description: Which Android version or web browser (depending on where this problem occurred) have you been using?
+      placeholder: e.g. Android 10 or Google Chrome
+    validations:
+      required: true
+  - type: input
+    id: user-roles
+    attributes:
+      label: User Role(s)
+      description: Please specify the user role(s) assigned to the user or users you have encountered this bug with. If your server is using custom user roles, we might request additional details in order to reproduce the issue.
+      placeholder: e.g. Admin and National User
+    validations:
+      required: true
+  - type: input
+    id: server-url
+    attributes:
+      label: Server URL
+      description: Please specify the server URL if you've encountered this bug on a test or demo server.
+      placeholder: e.g. https://test.sormas.netzlink.com
+    validations:
+      required: false
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: Additional Information
+      description: If there is anything else you want to add to your request, you can put it here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/CHANGE-REQUEST.yml

@@ -0,0 +1,66 @@
+name: 2 - Change Request
+description: Suggest the change of an existing feature.
+labels: 'change'
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for contributing to SORMAS! **Please make sure that your issue complies to our [Contributing guidelines](https://github.com/sormas-foundation/SORMAS-Project/blob/development/docs/CONTRIBUTING.md)** before submitting it.
+  - type: textarea
+    id: problem-description
+    attributes:
+      label: Problem Description
+      description: Tell us why you want us to change or extend an existing feature. Is there something working differently than you expect it? What can be improved about the way it is currently designed?
+    validations:
+      required: true
+  - type: textarea
+    id: proposed-change
+    attributes:
+      label: Proposed Change
+      description: Describe how you would like the feature to be changed and the expected outcome of your request. If possible and applicable, provide alternative solutions in case your proposed change can not be implemented in the way you outlined it for any reason.
+    validations:
+      required: true
+  - type: textarea
+    id: added-value
+    attributes:
+      label: Added Value/Benefit
+      description: Describe how your proposed change would add value to SORMAS and how implementing it would benefit the software or its users.
+    validations:
+      required: true
+  - type: textarea
+    id: acceptance-criteria
+    attributes:
+      label: Acceptance Criteria
+      description: Provide a list that describes in as much detail as possible what exactly needs to be done in order to fulfill your request (and, if applicable, also what should explicitely not be done). Use a task list for this purpose because it allows developers to easily document which acceptance criteria have been implemented.
+      placeholder: |
+        - [ ]
+        - [ ]
+        - [ ]
+      value: |
+        - [ ]
+        - [ ]
+        - [ ]
+    validations:
+      required: true
+  - type: textarea
+    id: implementation-details
+    attributes:
+      label: Implementation Details
+      description: Information about how the implementation should be handled from a technical perspective. They are usually specified by the developers and can be left empty unless you want to suggest a specific way to implement your request.
+    validations:
+      required: false
+  - type: textarea
+    id: mockups
+    attributes:
+      label: Mockups
+      description: If your change request requires non-trivial UI/UX work, please provide visual illustrations of how the result should look like. Depending on the complexity of the request, these can be e.g. edited screenshots, single mockups, or multiple mockups depicting a workflow.
+      placeholder: You can attach images by clicking this area to highlight it and then dragging them in.
+    validations:
+      required: false  
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: Additional Information
+      description: If there is anything else you want to add to your request, you can put it here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml

@@ -0,0 +1,59 @@
+name: 3 - Feature Request
+description: Suggest a new feature that you'd like to see in SORMAS.
+labels: 'feature'
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for contributing to SORMAS! **Please make sure that your issue complies to our [Contributing guidelines](https://github.com/sormas-foundation/SORMAS-Project/blob/development/docs/CONTRIBUTING.md)** before submitting it.
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: Feature Description
+      description: Describe the feature you would like to see in SORMAS, what it is supposed to do, and what function it fulfills. If possible and applicable, provide alternative solutions in case your proposed change can not be implemented in the way you outlined it for any reason.
+    validations:
+      required: true
+  - type: textarea
+    id: added-value
+    attributes:
+      label: Added Value/Benefit
+      description: Describe how the new feature would add value to SORMAS and how implementing it would benefit the software or its users.
+    validations:
+      required: true
+  - type: textarea
+    id: acceptance-criteria
+    attributes:
+      label: Acceptance Criteria
+      description: Provide a list that describes in as much detail as possible what exactly needs to be done in order to fulfill your request (and, if applicable, also what should explicitely not be done). Use a task list for this purpose because it allows developers to easily document which acceptance criteria have been implemented.
+      placeholder: |
+        - [ ]
+        - [ ]
+        - [ ]
+      value: |
+        - [ ]
+        - [ ]
+        - [ ]
+    validations:
+      required: true
+  - type: textarea
+    id: implementation-details
+    attributes:
+      label: Implementation Details
+      description: Information about how the implementation should be handled from a technical perspective. They are usually specified by the developers and can be left empty unless you want to suggest a specific way to implement your request.
+    validations:
+      required: false
+  - type: textarea
+    id: mockups
+    attributes:
+      label: Mockups
+      description: If your feature request requires non-trivial UI/UX work, please provide visual illustrations of how the result should look like. Depending on the complexity of the request, these can be e.g. edited screenshots, single mockups, or multiple mockups depicting a workflow.
+      placeholder: You can attach images by clicking this area to highlight it and then dragging them in.
+    validations:
+      required: false  
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: Additional Information
+      description: If there is anything else you want to add to your request, you can put it here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/FINDING.yml

@@ -0,0 +1,89 @@
+name: 4 - Finding
+description: Report an unexpected behavior you encountered while using or developing SORMAS.
+labels: 'finding'
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for reporting an unexpected behavior in SORMAS! **Please make sure that your issue complies to our [Contributing guidelines](https://github.com/sormas-foundation/SORMAS-Project/blob/development/docs/CONTRIBUTING.md)** before submitting it.
+  - type: textarea
+    id: problem-description
+    attributes:
+      label: Problem Description
+      description: Describe what exactly happened, where it happened and under which circumstances. Provide as many details as possible, even if they might seem irrelevant to you. **If you have access to the server logs, attach relevant log output in a .txt file here** as this helps us to identify whether the behavior is a bug and its source. Please don't copy and paste server logs directly unless they are very short. Also, if possible, attach at least one screenshot depicting the behavior (without exposing any protected data).
+      placeholder: You can attach server logs and screenshots by clicking this area to highlight it and then dragging them in.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: Reproduction Steps
+      description: If possible, provide step-by-step instructions of how you triggered the behavior, i.e. the order of actions you performed before it occurred. This helps us to reproduce it on our systems.
+      placeholder: |
+        1.
+        2.
+        ...
+      value: |
+        1.
+        2.
+        ...
+    validations:
+      required: false
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected Behavior
+      description: Shortly describe what you think should have happened instead of the reported behavior. Not necessary when the error is identified by a crash or an error message, but likely relevant when the problem is the result of a misbehavior of the application that results in an unexpected outcome.
+    validations:
+      required: false
+  - type: dropdown
+    id: affected-area
+    attributes:
+      label: Affected Area(s)
+      description: Did you encounter the behavior in the web app, Android app, or by using the ReST interface? You can select multiple values.
+      multiple: true
+      options:
+        - Web app
+        - Android app
+        - ReST API
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: SORMAS Version
+      description: Which version or versions of the software have you encountered the behavior in?
+      placeholder: e.g. SORMAS 1.81.0
+    validations:
+      required: true
+  - type: input
+    id: android-browser
+    attributes:
+      label: Android version/Browser
+      description: Which Android version or web browser (depending on where this problem occurred) have you been using?
+      placeholder: e.g. Android 10 or Google Chrome
+    validations:
+      required: true
+  - type: input
+    id: user-roles
+    attributes:
+      label: User Role(s)
+      description: Please specify the user role(s) assigned to the user or users you have encountered the behavior with. If your server is using custom user roles, we might request additional details in order to reproduce the issue.
+      placeholder: e.g. Admin and National User
+    validations:
+      required: true
+  - type: input
+    id: server-url
+    attributes:
+      label: Server URL
+      description: Please specify the server URL if you've encountered the behavior on a test or demo server.
+      placeholder: e.g. https://test.sormas.netzlink.com
+    validations:
+      required: false
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: Additional Information
+      description: If there is anything else you want to add to your request, you can put it here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/TASK.yml

@@ -0,0 +1,29 @@
+name: 5 - Task
+description: Document a task to be done by the development team that does not change the software.
+labels: 'task'
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for contributing to SORMAS! **Please make sure that your issue complies to our [Contributing guidelines](https://github.com/sormas-foundation/SORMAS-Project/blob/development/docs/CONTRIBUTING.md)** before submitting it.
+  - type: textarea
+    id: problem-description
+    attributes:
+      label: Problem Description
+      description: Describe the requirement or problem that is supposed to be solved.
+    validations:
+      required: true
+  - type: textarea
+    id: proposed-solution
+    attributes:
+      label: Proposed Solution
+      description: Describe in as much detail as possible how the proposed solution should look like and what should be done in order to achieve it. If possible, provide alternative solutions in case your proposed change can not be realized for any reason.
+    validations:
+      required: true
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: Additional Information
+      description: If there is anything else you want to add to your request, you can put it here.
+    validations:
+      required: false