react-component / react-component/slider
Changelog does not indicate breaking changes
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.1k
- Forks
- 768
- Avg merge
- 11d 22h
- Merged PRs (30d)
- 5
Description
I am assuming this slider component uses semantic versioning so that a major release indicates a breaking change. I skimmed the changelog and also the releases and I could find no mention of what the breaking change for version nine was. Is there any at all?
I think the release naming strategy should be mentioned in the README so that people know whether you are semver compatible or not. Also, in case you are, add the breaking changes when moving up a major version.
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 by reviewing the README, changelog, and releases around version nine to determine how release naming is currently presented. Document the project's semantic-versioning policy in the README and record breaking changes for major releases in the changelog; the documentation should clearly explain whether major versions indicate breaking changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100