tlks.io : libtlks

tlks.io core library

Table of contents

• Quick start
• Documentation
• Build status
• Bugs and feature requests
• TODO
• Contributing
• Versioning
• Creators
• Copyright and license

Quick Start

You need node.js installed:

$ git clone http://github.com/tlksio/libtlks
$ cd libtlks
$ npm install
$ make test

Documentation

Please check the whole Project Documentation repo at: tlks.io documentation

Build status

• Branch Master :

• Branch Develop :

• Coverage Master :

• Coverage Develop :

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

TODO

In order of precendence always work on existing issues before spending hours on new things.

If you have an idea for the future and it is not planed on the global roadmap please check the [TODO list of ideas] on every project repo and add your idea there to be discussed.

If you already added a new idea to one of the existing projects, go and ping to a developer and ask him to disscuss it. Good luck! ;)

This project TODO idea list is here: TODO.md.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, if your pull request contains patches or features, you must include relevant unit tests.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, libtlks is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever possible.

Creators

Raül Pérez

• https://twitter.com/repejota
• https://github.com/repejota

Copyright and License

Code and documentation copyright 2015 tlks.io authors.

Code released under the MIT license.