search

nodejs / abi-stable-node

Repository used by the Node-API team to manage work related to Node-API and node-addon-api
241 stars 34 forks source link

Discuss how we should advocate the use of badges in our documentation #333

Closed gabrielschulhof closed 5 years ago

gabrielschulhof commented 6 years ago

https://github.com/nodejs/admin/issues/221 opens the discussion on whether/how we should document that we recommend that add-on maintainers use badges to indicate that their module in N-API-based.

gabrielschulhof commented 6 years ago

Seems like there are no objections, so we can start opening PRs advocating the use of badges of the form [N-API|v<n>] where n is the N-API version number. Shall we go with [N-API|vx] if the addon needs experimental? That will later be replaced by the addon maintainer with a number once the API goes out of experimental. Maybe whenever choosing experimental, the colour should not be green, because depending on experimental carries with it a small chance of ABI breakage.

mhdawson commented 6 years ago

I'd agree with not being green if it uses experimental. Otherwise N-API|v sounds good to me.

digitalinfinity commented 6 years ago

Yup, seems like a reasonable plan

mhdawson commented 6 years ago

PR to add some text to node core https://github.com/nodejs/node/pull/22801#pullrequestreview-157171072

mhdawson commented 6 years ago

@gabrielschulhof Updated abi-stable-node readme repo, will land once 72 hours is up.

Next gabriel will suggest text on badges go into update readme.

gabrielschulhof commented 5 years ago

Since the issue in the core repo was closed, if/when we PR this, we should PR this against the README.md in this repo.

gabrielschulhof commented 5 years ago

At today's N-API meeting we discussed the possibility of suggesting at our N-API workshop that a badge be included in a PR that ports a module to N-API.

mhdawson commented 5 years ago

@gabrielschulhof submitted this pull request: https://github.com/nodejs/abi-stable-node/pull/357