Were there any breaking changes between v5 and v6?
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 43.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
When I look at the CHANGELOG.md it jumps from v5.4.3 to v6.0.5. I don't see any info about what is a breaking change between v5 and v6.
When I look in the github releases, I also see no tags/releases for v6.0.0 through v.6.0.4
I had to go digging in your commit history to find this:
- this commit bumps version from 5.4.2 to 6.0.2
- this commit which bumps version from 6.0.2 to 6.0.3
- this commit which bumps version from 6.0.3 to 6.0.4
When I browse files at that last commit and look at the CHANGELOG, I finally see v6.0.0 mentioned there and the info for it is exactly the same as v6.0.5
Can you update your CHANGELOG.md to note the breaking changes between v5 and v6 in your v6.0.5 section, even if it's something as minor as a change of supported Node version. It should be documented why there was a major version change and right now I can't tell from the CHANGELOG what is breaking or not
Contributor guide
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 with CHANGELOG.md and the v5.4.3-to-v6.0.2 version-bump commit, then review the linked v6.0.3 and v6.0.4 commits and their release history. Update the v6.0.5 section to explain the breaking changes between v5 and v6, including any supported Node version change, and clarify the missing v6 release entries.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100