Confusing/incorrect usage of the term "major version"
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 10
- Forks
- 79
- PR merge metrics
- No merged PRs in 30d
Description
According to Semantic Versioning the example describes a minor version, not a major version. Other parts on this page describe a "major update" which could also be confusing. I haven't reviewed the rest of the documentation regarding this terms but as a software engineer and administrator I generally expect the meanings as defined in semver unless explicitly stated otherwise.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at docs/admin/updating.md around line 54 and compare the wording with Semantic Versioning. Check the page's other uses of “major update” for the same ambiguity. The documentation is done when the example and related terminology distinguish major and minor versions consistently.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100