akita icon indicating copy to clipboard operation
akita copied to clipboard

Bring back a high-level, curated `CHANGELOG.md`

Open tony opened this issue 3 years ago • 1 comments
trafficstars

Description

It would be helpful to synthesize features end users would find important in a central CHANGELOG.md file.

Right now there is a monorepo where the user must go into the packages, open the change log, then view PRs that are merged - which don't provide high level insights

Proposed solution

Add back CHANGELOG.md and note new features, future and current deprecations, longstanding bug fixes in the project in a central place.

Examples:

  • https://github.com/facebook/react/blob/d483463/CHANGELOG.md
  • https://github.com/ReactiveX/rxjs/blob/bca49bd/CHANGELOG.md
  • https://github.com/angular/angular/blob/b184f0a/CHANGELOG.md

I lean more toward the releaser hand-making the changelog than it being machine-made. The reason why is when a release is published it's more fresh on a mind what changes the maintainer feels is significant

Alternatives considered

Any type of root-level change log file is tracker agnostic and goes wherever the project goes.

Do you want to create a pull request?

No

tony avatar Jan 09 '22 11:01 tony

Also, I would hold this to be good for https://github.com/ngneat/elf as well

I think it would greatly increase the clarity of the projects

An example of a project that does this very well is django:

  • https://docs.djangoproject.com/en/4.0/releases/4.0/
  • https://docs.djangoproject.com/en/4.0/releases/3.2/

They even have a specific page to keeping deprecation info: https://docs.djangoproject.com/en/3.2/internals/deprecation/

For projects like these, hand-made details on important changes would be invaluable.

tony avatar Jan 09 '22 12:01 tony