| 1 | # Contributing
|
| 2 |
|
| 3 | Thanks for your interest in classNames. Issues, PRs and suggestions welcome :)
|
| 4 |
|
| 5 | Before working on a PR, please consider the following:
|
| 6 |
|
| 7 | * Speed is a serious concern for this package as it is likely to be called a
|
| 8 | significant number of times in any project that uses it. As such, new features
|
| 9 | will only be accepted if they improve (or at least do not negatively impact)
|
| 10 | performance.
|
| 11 | * To demonstrate performance differences please set up a
|
| 12 | [JSPerf](http://jsperf.com) test and link to it from your issue / PR.
|
| 13 | * Tests must be added for any change or new feature before it will be accepted.
|
| 14 |
|
| 15 | A benchmark utilitiy is included so that changes may be tested against the
|
| 16 | current published version. To run the benchmarks, `npm install` in the
|
| 17 | `./benchmarks` directory then run `npm run benchmarks` in the package root.
|
| 18 |
|
| 19 | Please be aware though that local benchmarks are just a smoke-signal; they will
|
| 20 | run in the v8 version that your node/iojs uses, while classNames is _most_
|
| 21 | often run across a wide variety of browsers and browser versions.
|