Scope Naming Guidelines (for Sublime Text)

This repository holds a collection of documents providing guidelines for scope naming in syntax definitions for Sublime Text.

Currently a work in progress.

Documents

1. Base Scope

Motivation

Spawned from an idea posted in the Packages repository, the repository was created to

1. streamline the process of deciding on guidelines for scope naming,
2. provide more details on corner cases,
3. give concrete examples,
4. and create a referenceable collection of documents.

As such, all documents are assigned a unique number that is determined incrementally on merge and follow a template that ensures the above goals are met. Documents may be modified and are versioned following SemVer.

Workflow

1. A Pull Request is proposed for an existing document or a new document is added.
   • Newly added documents must be named following 000-<title>.md and follow the provided template, as well as our contribution guidelines.
   • The new version according to SemVer must be provided, based on the current changeset. The first version is always 1.0.0. Furthermore, an incrementing pre-release identifier of -rfc.0 is added.
2. The pull request is discussed and iterated on based on feedback by the community. For each iteration, the pre-release version is increased to create a unique reference for this version.
3. Eventually, a majority of [certain people?] and the maintainer of the document, if any, approve of the PR or reject it. [TO BE DECIDED]
4. When approved, the PR is merged and the metadata is finalized. Additionally, the -rfc.… pre-release suffix is removed.

Copyright

To the extent possible under law, the contributors of this work have waived all copyright and related or neighboring rights to this work.

See LICENSE for the full text.