Release automation won't kick off if a release PR is mistitled
- Dominant language
- TypeScript
- Stars
- 413
- Forks
- 308
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 253
Description
It is common for developers to create a release PR but then fail to name the PR "Release X.Y.Z". Unfortunately they don't know that this won't work until it's too late.
We should document the expectations for release PR titles. We should also possibly figure out a way to detect when the root package has been bumped and advise the developer accordingly, perhaps by automatically posting a comment on the PR.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the release automation and release PR workflow to confirm where the title requirement is enforced. Document the expected “Release X.Y.Z” title and explain when it matters; treat automatic detection and comments as a separate scope unless an existing project hook is identified. Done means developers can find and follow the release PR naming guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100