It's not clear in the contributor docs that dependents should be released alongside major-bumped packages
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 413
- Forks
- 308
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 253
Description
When an engineer goes to bump a major version of a package, `create-release-branch` informs them that dependents should be bumped and included in the release as well. This is good, but we should also include this in the contributor docs so we can link to it within Slack or other places.
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
Locate the contributor documentation and the create-release-branch guidance referenced in the issue. Add the instruction that dependents of a major-bumped package should also be bumped and included in the release, then verify the documentation is clear enough to link from Slack or other places.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100