it11012280 - Colish naming specification

Products and naming guidelines

By Ian Williams | 18 July, 2020

1. Introduction

This document contains guidelines for the naming of:

  • Products
  • Versions

1.1 Definitions

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” used in this document are to be interpreted as described in RFC 2119 .

1.2 External documents

The following external documents are part of this document:

Name Title
SemVer Semantic Versioning https://semver.org/spec/v2.0.0.html (or its latest version).
RFC 2119 Key words for use in RFCs to Indicate Requirement Levels

2. Colish (Generic)

The generic name, as a short form of Common English, is written:

Colish

3. Products

3.1 Product names

Colish org products SHALL be written in capital letters.

  • COLISH = Colish as a product, with its own Product Lifecycle and versions.

3.2. Product versioning

Product versions SHALL use the versioning nomenclature X.Y.Z (Major.Minor.Patch).

The version naming paradigm, as specified in the SemVer Specification, shall be used.

4. Product COLISH

4.1 COLISH version names

COLISH versions shall be referenced as follows:

  • Co1 = COLISH version 1.x.x
  • Co2 = COLISH version 2.x.x
  • Co3 = COLISH version 3.x.x
  • etc.

Note: Notice the use of smallcase in the version name as an optical delimiter.

Co0, or Co-Zero, is the development version before release.

4.2 Pre-Colish

The generic reference to English spelling before Colish was born is one of the following (with spelling variations):

Co-Retro | CoRetro | Coretro