Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Please consider using `CHANGES`

See original GitHub issue

Feature request

#14596

What is the expected behavior?

To have a single CHANGES.md/CHANGELOG.md file, sync’d with git tags (moving forward)

Even better, to have it curated by hand

What is motivation or use case for adding/changing the behavior?

It’s not currently possible for users to understand what’s happening in the project without disproportionate effort.

How should this be implemented in your opinion?

One file.
Markdown
Named CHANGES.md or CHANGELOG.md or RELEASES.md
Sync’d with git tags
New PRs should be required to update change file and describe their change
Upon releasing, the changes should be written out by hand and curated

Example, assume v5.63.0


## v5.63.0 - 2021-11-09

### Features
- allow passing chunkLoading: false to disable on-demand loading

#### Bugfixes
- fix import 'single-quote' in esm build dependencies

Are you willing to work on this yourself? I will port it over by hand if maintainers can agree on a style / format ahead of time.

Issue Analytics

State:
Created 2 years ago
Reactions:1
Comments:12 (7 by maintainers)

Top GitHub Comments

2reactions

tonycommented, May 10, 2022

Anyone else want a single-file change log?

2reactions

alexander-akaitcommented, Feb 7, 2022

Sounds reasonable, let’s revisit it

Top Results From Across the Web

MySQL installation on Ubuntu 20.04 error when using ...

I'm trying to install MySQL on Ubuntu 20.04 and when I run the command sudo mysql_secure_installation , it fails with the error below:...

MySQL root password setup error - Ask Ubuntu

I use my mysql session to run ALTER USER: mysql> ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password by 'my-secret-password ...

please consider that changes | English examples in context

High quality example sentences with “please consider that changes” in context from reliable sources - Ludwig is the linguistic search engine that helps...

Please consider the following changes. or Please ... - TextRanch

We will make the following changes to the contents of this regulation proposal. Can we please consider the threshold that we are crossing?...

Failed! Error: SET PASSWORD has no significance for user ...

Please consider using ALTER USER instead if you want to change authentication parameters. To clear more you could read ...