Arquivos
NodeCopterHack/node_modules/ar-drone/node_modules/buffy/CONTRIBUTING.md
T
2013-08-10 13:15:52 +01:00

888 B

Contributing

Running the test suite

$ git clone <git url>
$ cd <clone dir>
$ npm install
$ make test

Running an individual test

$ node test/unit/test-Reader.js

TODOS

If you are looking for something to work on, here are a few things I'd like to see in this module:

  • Implement benchmark suite (with some nice R analysis)
  • Implement reader.compact() and/or new Reader({compact: true}). Allows for the internal this._buffer to shrink. (The current behavior is to grow the internal buffer until it can hold the biggest buffer passed into write()).
  • Implement Writer class. Will probably create many internal buffers and flatten them into one at the end. Should also support to be initialized with a length in which case small buffers are not created all the time.

And of course, feel free to send patches for any open tickets / bugs.