Create an issue

Issue creation is the first step in the issue life cycle and is a vital part of the errata service as it revolves around community contributions. However, creating an issue must abide to a set of rules.

  1. Log in to the Errata Service

  2. From the Errata Service home page, click on “Create” in the upper-right menu.

    Create Issue Form

  3. Fill the form following the requirements:

    • The project is mandatory and value-controlled.

    • A title between 16 and 255 characters is mandatory.

      Warning

      You won’t be able to change the project and the title again !

    • A description between 16 and 1023 characters is mandatory. A precise and concise issue description that must make sense for end users (not just “wrong data”) is highly recommended.

    • The severity is mandatory and value-controlled.

      Note

      The accepted terms for issue severity are:

      “Low”

      The issue concerns file management (e.g., addition, removal, period extension, etc.),

      “Medium”

      The issue concerns metadata (NetCDF attributes) without undermining the values of the involved variable,

      “High”

      The issue concerns single point variable or axis values,

      “Critical”

      The issue concerns the variable or axis values undermining the analysis. The use of this data is strongly discouraged.

    • Optional links and materials are expected to be a valid URL(s) (checked upon validation).

    • The datasets list is mandatory and gathers all the identifiers of the affected datasets.

      Note

      A dataset identifier is a sequence of dot-separated facets that follows the Data Reference Syntax of the corresponding project. The dataset identifiers has to append the dataset version number. If one of the dataset ID is malformed or if the dataset list is empty, the form will raise an error.

    Create Issue Form

  4. Click on “Save” in the upper-right menu.

    Create Menu

  5. Your request will be processed and validated by the server.

  6. If successfully saved, you are redirected to the newly generated view of your issue.

    Creation Success

  7. If invalid issue, you are requested to correct the form depending on the error message and try again.

    Creation Fail

Note

The Errata Service will automatically assign the status “New”.

Note

The Errata Service automatically generates a unique identifier on issue creation and assigns to the issue throughout its life cycle. This identifier can be use to retrieve the issue through the Errata Service CLI.

Note

The creation date and authors are also automatically assigned to the issue by the server.