Add a section about versioning to the meta document #62
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #10
What
This pull request adds a section to the meta document about versioning. It states that we use semantic versioning, details how semantic versioning is being applied to a text document rather than the usual software api, explains the rationale for that interpretation, gives a concrete example of that interpretation being applied to a hypothetical change and warns readers about the possibility of breaking changes in minor versions when using new PHP features before this PER standardises their style. Compared to the initial draft I shared in discord or the original comment in #10, it is less prescriptive about RFC 2119 keywords and more focused on the outcome for authors and projects.
Why at all?
The PER workflow bylaws state that votes must be held for new releases that would be minor or major according to semantic versioning. Importantly, to my reading, it does not require that the releases themselves must be labelled according to semver; it would be equally valid to have release numbers that eg match php releases, provided votes are still held at the required times. Even if the bylaws did require that, they aren't an obvious place to look for spec readers. This addition makes it abundently clear we follow semver.
As written in the proposed section, semver is well defined when applied to software releases but has no common definition in other contexts. Even within the working group, our first instincts on how semver applies to a coding guidelines standard weren't a perfect match. In particular, the potential for breaking changes in minor versions if you use PHP features undocumented in the spec isn't necessarily intuitive. This section aims to convey to readers a high level understanding that is consistent with our current understanding, recognising we can't predict the low level nuance of every future change in advance.
Why now?
Excluding 1.0 as a clone of PSR-12, this is effectively the first substantial release of any PER. How we handle releases is to me a critical process issue, both for ourselves and in establishing a precedent/example for future PERs. In my opinion, it is insufficient for an open github issue (especially with unresolved working group comments) to fulfil the role of documenting this critical process because:
Including this PR now, or an alternative wording, will: