https://github.com/sublimetext/scopenamingguidelines

Collection of documents for scope naming guidelines in Sublime Text syntax definitions
https://github.com/sublimetext/scopenamingguidelines

hacktoberfest knowledge-base rfc scope-naming sublime-text syntax-highlighting

Last synced: 7 days ago
JSON representation

Collection of documents for scope naming guidelines in Sublime Text syntax definitions

• Host: GitHub
• URL: https://github.com/sublimetext/scopenamingguidelines
• Owner: SublimeText
• License: cc0-1.0
• Created: 2020-02-11T23:53:49.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-03-10T13:18:04.000Z (8 months ago)
• Last Synced: 2024-05-01T21:22:17.987Z (7 months ago)
• Topics: hacktoberfest, knowledge-base, rfc, scope-naming, sublime-text, syntax-highlighting
• Homepage:
• Size: 25.4 KB
• Stars: 11
• Watchers: 10
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](./documents/001-base-scope.md)

## Motivation

Spawned from an idea posted [in the Packages repository][idea],

the repository was created

to

1. streamline the process of deciding on guidelines for scope naming,

1. provide more details on corner cases,

1. give concrete examples,

1. 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-.md`

     and follow the provided template,

     as well as our [contribution guidelines](./CONTRIBUTING.md).

   - 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.

1. 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.

1. Eventually, a majority of \[certain people?\]

   and the maintainer of the document, if any,

   approve of the PR or reject it.

   **\[TO BE DECIDED\]**

1. When approved, the PR is merged and the metadata is finalized.

   Additionally, the `-rfc.…` pre-release suffix is removed.

[Sublime Text]: https://sublimetext.com/

[idea]: https://github.com/sublimehq/Packages/issues/1440

[SemVer]: https://semver.org/

## 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](./LICENSE) for the full text.