-
Notifications
You must be signed in to change notification settings - Fork 345
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Bring back a high-level, curated CHANGELOG.md
#787
Comments
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:
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
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
The text was updated successfully, but these errors were encountered: