Thanks for considering a contribution to Retire.js.
- Keep PRs focused on a single change (one bug fix, one library addition, one feature). Unrelated changes make review harder and should go in separate PRs.
- All commits must be signed.
- Describe why the change is needed, not just what changed.
See node/README.md for usage and options.
- Build and run the test suite before submitting:
npm run build && npm run test(specs import fromlib/, notsrc/, so the build step is required). - Run
npm run check(lint + typecheck). - Tests should be split into one test file per module being tested — e.g. don't bundle tests for
x.tsandy.tsinto a shared spec file unless there's no reasonable way to separate them. - Do not add new dependencies unless absolutely necessary
See repository/README.md for the entry format.
- Make changes in
jsrepository-master.jsononly. Never editjsrepository.jsondirectly (it's generated) or submit tonpmrepository.json(deprecated). - After editing
jsrepository-master.json, regenerate derived files withnode convertToVersioned. - Before submitting, run
node validateandnode test-detection.js. - Each vulnerability entry needs a
severity,cwe, and at least one identifier (CVE,githubID,pr, orissue).
See chrome/README.md and firefox/README.md for extension-specific details. Note the Firefox extension is deprecated.
Browser extensions must not pull in additional dependencies. This is also true for the HTML popups (must not use external fonts, images, scripts etc.).