Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

25 lines (19 loc) · 1.19 KB

Contributing

Thanks for your interest in classNames. Issues, PRs and suggestions welcome :)

Before working on a PR, please consider the following:

  • Speed is a serious concern for this package as it is likely to be called a significant number of times in any project that uses it. As such, new features will only be accepted if they improve (or at least do not negatively impact) performance.
  • To demonstrate performance differences please set up a JSPerf test and link to it from your issue / PR.
  • Tests must be added for any change or new feature before it will be accepted.

A benchmark utility is included so that changes may be tested against the current published version. To run the benchmarks, run npm install in the root directory then run npm run bench.

Please be aware though that local benchmarks are just a smoke-signal; they will run in the v8 version that your local Node.js uses, while classNames is most often run across a wide variety of browsers and browser versions.

It is recommended to test possible regressions in performance in all major browsers. This can be done by running npm run bench-browser, the benchmark will then be served from http://localhost:8080.