mapbox / node-pre-gyp

Node.js tool for easy binary deployment of C++ addons
BSD 3-Clause "New" or "Revised" License
1.1k stars 259 forks source link

update changelog for pending release #833

Open benmccann opened 2 days ago

cclauss commented 2 days ago

I think our changelog and readme should both state that we will attempt to track with https://github.com/nodejs/release#release-schedule and on a rolling basis we will not support Node.js versions that have fallen off that list.

In the changelog, let's put dependency upgrades after all other changes so that the document is easier to scan. Dependencies should appear in alphabetical order for readability reasons.

Please simplify https://github.com/mapbox/node-pre-gyp/blob/master/README.md#appveyor-automation to point readers to:

  1. https://ci.appveyor.com/project/Mapbox/node-pre-gyp/history
  2. https://github.com/mapbox/node-pre-gyp/blob/master/appveyor.yml
  3. http://www.appveyor.com/docs/appveyor-yml

Please remove https://github.com/mapbox/node-pre-gyp/blob/master/README.md#travis-automation and instead briefly describe how to find our GitHub Actions and their test results.

Thanks much!!

benmccann commented 2 days ago

I think our changelog and readme should both state that we will attempt to track with https://github.com/nodejs/release#release-schedule and on a rolling basis we will not support Node.js versions that have fallen off that list.

Done

In the changelog, let's put dependency upgrades after all other changes so that the document is easier to scan. Dependencies should appear in alphabetical order for readability reasons.

Done

Please simplify https://github.com/mapbox/node-pre-gyp/blob/master/README.md#appveyor-automation ...

I will leave the readme updates for someone who is more familiar with the details as I don't feel I would do a good job updating these sections.