CHANGELOG confusion/maintenance
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1k
- Forks
- 348
- Avg merge
- 12h 28m
- Merged PRs (30d)
- 91
Description
Is your feature request related to a problem? Please describe.
It is easy for a visitor to be confused about what the latest release is and what the latest changes are. Combined with no tags being marked as real releases here on GitHub, it gives the impression that the CHANGELOG is out of date and unmaintained - or project less active/maintained than it really is.
When the real issue is that the one in main maintained separately than the one in the tagged branches I guess.
https://github.com/nextcloud/mail/blob/main/CHANGELOG.md
versus
https://github.com/nextcloud/mail/blob/v3.5.5/CHANGELOG.md
(and, yes, I know the changes are in the app store) ;-)
Describe the solution you'd like
CHANGELOG.md in main maintained or, at the very least, releases tagged so that those not actively involved have a chance of realizing that the default CHANGELOG.md isn't actually the up-to-date one.
Describe alternatives you've considered
No response
Additional context
No response
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
Compare CHANGELOG.md on main with the version in the v3.5.5 tagged branch, then inspect how releases are represented in GitHub and the app store. A decision is needed between maintaining the main-branch changelog and marking releases clearly; done means visitors can identify the latest release and changes without confusion.
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
- Needs clarification
- Newbie friendliness
- 35/100