node-iconv icon indicating copy to clipboard operation
node-iconv copied to clipboard

What about CHANGELOG.md

Open vovs03 opened this issue 5 years ago • 5 comments

:question: What about :memo: CHANGELOG.md

If is it possible, it will be cool!

  • [ ] CHANGELOG.md
# CHANGELOG

**v.2.3.5**
- `on Sep 30, 2019 `
  - describe

...

**v. 2.3.0**
- `on Jun 26, 2017`
  - describe

vovs03 avatar Nov 10 '19 05:11 vovs03

especially, if you do major version updates, like the recent 2.x to 3.x, I'd like to understand if there are breaking changes, so a CHANGELOG would be the natural place to search.

stheine avatar Apr 29 '20 06:04 stheine

@bnoordhuis I recommend to use npm i -g [email protected] and np to publish versions, which will auto-open GitHub releases page (similar to release) and provide a changelog for each version, then you wouldn't need a CHANGELOG and your existing releases would have much more detail

niftylettuce avatar May 04 '20 04:05 niftylettuce

@niftylettuce I might start using that from now on, thanks for the tip.

@stheine Really the only change is that using iconv from worker_threads now works (#211) and that required bumping the minimum supported node.js version.

bnoordhuis avatar May 04 '20 09:05 bnoordhuis

GitHub's releases is the great alternative to CHANGELOG file. But it would be great to read why major change happened, like here:

@bnoordhuis ...required bumping the minimum supported node.js version.

What minimum required node.js version now?

dr-dimitru avatar May 10 '20 13:05 dr-dimitru

@dr-dimitru see the engines field in package.json https://github.com/bnoordhuis/node-iconv/blob/master/package.json#L15

niftylettuce avatar May 11 '20 00:05 niftylettuce