matrix-org / matrix-org/matrix-js-sdk
Breaking changes are not adequately documented
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.2k
- Forks
- 704
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 40
Description
Release page for https://github.com/matrix-org/matrix-js-sdk/releases/tag/v21.0.0 says that callback support has been removed from *a lot of the methods* but it doesn't list those methods.
Could these SDK releases have proper documentation on breaking changes so that people using outside of Element also able to upgrade easily?
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 the v21.0.0 release page and review how this SDK records release and breaking-change information. Identify the methods affected by callback removal and document them for SDK users outside Element, while making the release notes clear about upgrade impact. Done means the affected methods and breaking changes are explicitly listed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100