mobxjs / mobx-state-tree

Full-featured reactive state management without the boilerplate
https://mobx-state-tree.js.org/
MIT License
6.94k stars 641 forks source link

Single file, curated CHANGELOG #1947

Closed tony closed 1 year ago

tony commented 2 years ago

Hi, thank you for the project!

Feature request Changelog file

Is your feature request related to a problem? Please describe. <4.0's changelog was better IMO.

Describe the solution you'd like

Describe alternatives you've considered There's no alternative but it seems changelog.md was removed in favor of releases in >4.0 in favor of GitHub Releases.

Additional context

See https://github.com/webpack/webpack/issues/15318 for the rationale / example I've given GitHub Releases (fragmented, undifferentiated, and in a "blog" subsite detached from any changelog file): https://user-images.githubusercontent.com/26336/185774527-2150ac43-9a6c-4281-84d4-7ccb5db1924e.mp4 Babel's single file changelog (everything's on one page, at least): https://user-images.githubusercontent.com/26336/185774539-f02b0c23-493d-4850-b70e-ff162a4f4ff9.mp4

Are you willing to (attempt) a PR?

tony commented 2 years ago

I should also rewind: I am in a chipper disposition and am happy with the project. Just have a universal distaste for GH Releases.

I've nothing wrong with GH Releases to supplement things, but I'd never suggest it as a replacement for an actual changelog

Example from a project of mine: CHANGES file, CHANGES on docs site, Release

coolsoftwaretyler commented 1 year ago

Hey @tony! Sorry no one got back to you for so long.

I'm going to convert this to a discussion topic, rather than an issue. I don't want to close it out entirely, but I am just sort of getting up to speed on the core team here and I don't have a yes/no for you.

Thanks for the idea, and apologies once more for the delay!