Skip to content
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

Not having a changelog document is a mistake #11035

Open
1 of 3 tasks
hlovdal opened this issue Jan 6, 2023 · 4 comments
Open
1 of 3 tasks

Not having a changelog document is a mistake #11035

hlovdal opened this issue Jan 6, 2023 · 4 comments

Comments

@hlovdal
Copy link

hlovdal commented Jan 6, 2023

Documentation Is:

  • Missing or needed?
  • Confusing
  • Not sure?

Please Explain in Detail...

I know this has been asked before, but the claim that https://github.com/chartjs/Chart.js/releases is sufficient is simply false.

Take for instance the 3.0.0 release. It contains ZERO information about breaking changes. None - zip - nada.

Do you honesestly think that is acceptable?

It contains links to 22 included pre-releases, are people supposed to be detectives and open each and every of them, and aggregate the breaking changes information themselves?

And if they attempt to do so, the first one (v3.0.0-alpha) contains no concrete information but instead links to a migration guide. The link is dead and gives a 404 error...

Seriously, do you really think this is good enough?

Your Proposal for Changes

There should exist a changelog document.

Example

No response

@LeeLenaleee
Copy link
Collaborator

LeeLenaleee commented Jan 6, 2023

All the breaking changes can be found in the migration guides.

We only do breaking changes with major version increases so between versions there are none.

And for all other releases the release notes genereated by github releases are fully covering.

Also 99% of the breaking changes are in the same GH release. This makes maintance burden a lot lower since we are with a small team

@kurkle
Copy link
Member

kurkle commented Jan 7, 2023

Should create a redirect for the 404 migration guide link in those old release notes.

Maybe the links in release notes should also point to the exact version of docs (not sure how easy that would be to do)?

I,m not against a changelog, if it is automatically generated from pull requests.

@honzajavorek
Copy link

The ask is legit, but why is the tone of the issue so entitled? If you are writing sentences like „Do you honesestly think that is acceptable?“ or „Seriously, do you really think this is good enough?“, my question would be how much did you pay to the maintainers team for this amazing library, which otherwise saves you billion hours of coding time?

I'm not affiliated to the maintainers, just passing by.

@LeeLenaleee
Copy link
Collaborator

With the 4.3 release links in the release notes are pointing to the exact version and there is a redirect to the v3 migration guide

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants