Detect trailing garbage in the changelog
Open
Nobody has claimed this yet.
releasable
- Dominant language
- Raku
- Stars
- 19
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
I had something like this:
+ Revert "Revert "Revert potentially confusing "is default" changes"" [f1464e22] TODO DELETE?
I probably should not leave TODO comments while I'm working on the changelog, but releasable can be smart enough to detect things like this.
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
The issue mentions releasable and provides a malformed changelog line ending in “TODO DELETE?”; start by locating releasable’s changelog validation entry point. Reproduce the example and clarify the expected detection or report, since no file or test is named. Done means trailing garbage like this is detected reliably.
Written by the indexing model from the issue text.
Assessment
- Domain
- release
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100