Skip to content

Draft issue template for: Register new VERS type #133

Description

@mjherzog

We need an issue template to capture important information about a new VERS type that is not covered by vers-type-definition.schema-0.2.json (to be upgraded to v1.0) when we finalize the ECMA-VERS 1st Edition package.

The information we need to collect includes:

  • Native version scheme
    {Background information about the native version scheme for this VERS type}

  • Native syntax
    {Description of the native syntax or notation for the version range described by this VERS type.}

  • Native comparator mappings
    {List of mappings from the native range syntax comparators mapping to VERS equivalent comparators}

  • Version comparison procedure
    {List of steps describing in plain text the procedure to compare two versions for this VERS type. Comparison also enables sorting constraints to build a canonical VERS.}

  • Normalization rules
    {Description of rules to normalize native version ranges to valid constraints. }

The reasons not to include this in the first version of the VERS type definition schemas include:

  • Most of this information is narrative/text so not something that a tool can use programmatically
  • We are still working on our first set of registered VERS types so we do not have the practical experience yet to add this information to an official schema

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

VERS typeRelated to VERS 'type' - this VERS component was previously know as 'version-scheme'

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions