Contributing

Contributing to Brototype

Brototype is popular and funny, so no doubt you'll probably be tempted to contribute. And we hope you do! But there are just a few things to keep in mind...

While the naming scheme is entertaining, the point of the library is still actually to do useful things. So please, don't just write a method for the sake of making a joke. Superfluous methods won't be merged, no matter how entertaining their names may be.

Tests

All functionality should be unit tested. And any changes should pass the unit tests.

Unit tests can be executed by running npm test at the command line. Note, you'll need to have Node and Mocha installed.

Documentation

If you intend to add or change functionality, please be kind enough to also update the documentation in the README.md file.

Style

Let's try to keep the code readable. Please, no mystical one-liners.