clj-wordcloud/CONTRIBUTING.md
2018-03-22 21:45:38 +05:30

14 lines
687 B
Markdown

This library is a wrapper around [kumo](https://github.com/kennycason/kumo) . You can look into the source for things to port. Fork and make a PR.
## API guidelines
* API should be compatible with [kumo](https://github.com/kennycason/kumo) and please refer to the repo for implementing new APIs.
## Code guidelines
* Please use [aligned maps](https://github.com/bbatsov/clojure-style-guide#vertically-align-let-and-map) . In emacs select the map and hit `C-c SPC`. Refer : https://github.com/clojure-emacs/clojure-mode#vertical-alignment
## Doc guidelines
* Please document the feature in `examples` directory. Feel free to add an image if it's useful to convey the option better.