editorconfig / specification

Specification of EditorConfig file format
https://editorconfig-specification.readthedocs.io
BSD 2-Clause "Simplified" License
89 stars 26 forks source link

Spec version follows Semantic Versioning 2.0.0 #22

Closed cxw42 closed 4 years ago

cxw42 commented 4 years ago

Implements https://github.com/editorconfig/editorconfig-vote/issues/12.

Ref.: editorconfig/editorconfig#395

In #17, I didn't realize v0.13 of editorconfig-core-test had already been tagged. Therefore, I propose bumping the version at line 217 to v0.14.0 and tagging editorconfig-core-test in its current state as 0.14.0.

ffes commented 4 years ago

And shouldn't the version be included in conf.py?

Taken from another project:

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.14.0'
# The full version, including alpha/beta/rc tags.
release = '0.14.0'

Haven't tried it out myself yet, but as I read the comments above you can even replace the hardcoded version numbers with |version|.

cxw42 commented 4 years ago

And shouldn't the version be included in conf.py?

Done! Sphinx didn't substitute |version| in the header, so I put the version number between the top header and the TOC.

cxw42 commented 4 years ago

bump

ffes commented 4 years ago

@cxw42 There still is one question pending. I think that question is relevant.

cxw42 commented 4 years ago

@ffes I'm sorry to say I'm not sure which question you are referring to, but I believe you that it is still open! Would you please refresh my memory? I've looked back through the comments here but am missing something. Thanks!

ffes commented 4 years ago

@cxw42 My comment is about the lines 223-225. When you scroll up, you see a yellow Pending tag in my comment about those lines.

Shouldn't this be the other way around? core-tests already follows SemVer and because of that we let the specs do the same.

So I think "specification" and "core-tests repository" should be swapped.

cxw42 commented 4 years ago

@ffes I am sorry to say I can't see your comment --- I think you have to submit a review (see step 7 here) before it is available to anyone else.

Anyway, thanks for posting the text of your comment so I can respond! :) I have removed the word "therefore". Based on your comment, it wasn't actually necessary, and was in fact causing confusion. Sound OK to you?

Diff from bc96c75 to 66377e1:

 The version numbering of the specification follows
-`Semantic Versioning 2.0.0`_ ("SemVer").  Therefore, the version numbering of
+`Semantic Versioning 2.0.0`_ ("SemVer").  The version numbering of
 the `core-tests repository`_ also follows SemVer.
ffes commented 4 years ago

I am sorry to say I can't see your comment --- I think you have to submit a review (see step 7 here) before it is available to anyone else.

You're right. My bad 😕. I have not done that many reviews this way.

The text looks good to me.

cxw42 commented 4 years ago

@ffes thanks! I have yet to find an ideal code-review interface myself :) .

Anybody with merge authority, I believe this is now ready!

ffes commented 4 years ago

With three people approving this, I'm gonna press that button

As always, @cxw42 thanks for your hard work

cxw42 commented 4 years ago

@ffes Happy to help out! Thank you!