humlab-swedeb / swedeb-api

1 stars 0 forks source link

Feedback function to report data-error from SweDeb to Swerik as a filed issue on GitHub #72

Open fredrik1984 opened 1 month ago

fredrik1984 commented 1 month ago

Currently, SweDeb has a function to report speech data errors that originate from Swerik's annotation work. This report function directs the user to Swerik's GitHub-discussion forum. This is an ok first step to allow users to send feedback to the Swerik organization about errors.

However, there are some downsides to this: 1) SweDeb users need to have a GitHub account to report issues, and 2) it is messy for the Swerik project to handle error reports as discussion threads and not as GitHub issues.

Hence, we should ideally create an error report function that looks like this:

  1. The SweDeb user finds an error in a speech.
  2. When the user clicks on "Rapportera fel" a form-window opens that contains (A) pre-filled metadata about the speech, (B) options to choose between different error categories (OCR-fel, metadata, textsegmentering), (C) a possibility for the user to describe the error in free text.
  3. When the user has filled in the error report form the user clicks on "Skicka felrapport" and the form window closes.
  4. The error report is then automatically sent to Swerik's GitHub where it is automatically turned into a filed issue in a repository for error reports. Ideally, depending on the error category (OCR, metadata, textsegmentering), the error report is sorted under the relevant error category issue/repository.

Step 4 requires some kind of GitHub account. One solution would be to have SweDeb as a GitHub-account user, through which all SweDeb users file their error reports.