Skip to content

Commit

Permalink
Spec version follows Semantic Versioning 2.0.0 (#22)
Browse files Browse the repository at this point in the history
* Spec version follows Semantic Versioning 2.0.0

Implements editorconfig/editorconfig-vote#12

* Add version number to conf.py

Suggested by ffes in
#22 (comment)
  • Loading branch information
cxw42 authored Oct 18, 2020
1 parent 437d266 commit ed0a5ef
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 5 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,18 @@ available at https://editorconfig-specification.readthedocs.io/en/latest/ .

## Build

To build, first install [Sphinx][], and then, in the same directory as this
To build, first install [Sphinx], and then, in the same directory as this
file, run

make html

The built HTML files should be in `_build`.

## Making changes

- Alter the content in `index.rst`
- Update the version and release numbers in `conf.py`
- Submit a GitHub pull request to the [specification repo].

[specification repo]: https://github.com/editorconfig/specification/
[Sphinx]: https://www.sphinx-doc.org/en/latest/usage/installation.html
4 changes: 3 additions & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@
# -- Project information -----------------------------------------------------

project = 'EditorConfig Specification'
copyright = '2019, EditorConfig Team'
copyright = '2019--2020, EditorConfig Team'
author = 'EditorConfig Team'

version = '0.14.0'
release = '0.14.0'

# -- General configuration ---------------------------------------------------

Expand Down
13 changes: 10 additions & 3 deletions index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. Copyright (c) 2019 EditorConfig Team
.. Copyright (c) 2019--2020 EditorConfig Team
All rights reserved.
Redistribution and use in source and binary forms, with or without
Expand Down Expand Up @@ -26,6 +26,8 @@
EditorConfig Specification
^^^^^^^^^^^^^^^^^^^^^^^^^^

This is version |version| of this specification.

.. contents:: Table of Contents

Introduction (informative)
Expand Down Expand Up @@ -214,12 +216,16 @@ TODO. For now please read the `Plugin Guidelines`_ on GitHub wiki.
Versioning
==========

*This section applies beginning with v0.13 of this specification.*
*This section applies beginning with version 0.14.0 of this specification.*

This specification has a version, tagged in the `specification repository`_.
Each specification version corresponds to the same version in the
`core-tests repository`_.

The version numbering of the specification follows
`Semantic Versioning 2.0.0`_ ("SemVer"). The version numbering of
the `core-tests repository`_ also follows SemVer.

Each EditorConfig core, to pass the core tests, must process version
numbers given with the ``-b`` switch, and must report version numbers when
given ``-v`` or ``--version``. The version numbers used for ``-b``, ``-v``,
Expand All @@ -228,7 +234,7 @@ Vimscript core might respond to ``-v`` with:

::

EditorConfig Vimscript core v1.0.0 - Specification Version 0.13
EditorConfig Vimscript core v1.0.0 - Specification Version 0.14.0

Cores, plugins, or editors supporting EditorConfig have their own version
numbers. Those version numbers are independent of the version number of
Expand All @@ -238,4 +244,5 @@ this specification.
.. _Python configparser Library: https://docs.python.org/3/library/configparser.html
.. _Plugin Guidelines: https://github.com/editorconfig/editorconfig/wiki/Plugin-Guidelines
.. _plugin-tests repository: https://github.com/editorconfig/editorconfig-plugin-tests
.. _Semantic Versioning 2.0.0: https://semver.org/spec/v2.0.0.html
.. _specification repository: https://github.com/editorconfig/specification

0 comments on commit ed0a5ef

Please sign in to comment.