CONTRIBUTING

CliFM's Contribution Guidelines

1) The best way to contribute is taking a look at the currently open issues and provide some help, or creating a new one pointing out bugs (make sure to provide enough information to make the bug reproducible) and suggesting missing or wanted features. We'll do our best to fix whatever is broken and to add/improve whatever is missing. Always bear in mind the bugs and feature request templates, and, in case of sending us some code or patch via a pull request, the coding guidelines.

2) If you want to directly contribute to the project adding a feature, there is a simple way that do not involve getting your hands dirty with the source code: write a plugin (in any language you know) and submit it via a pull request: plugins could be simple, few lines long shell scripts.

3) If you are a designer, or if you just enjoy creating designs, you can develop some nice colorscheme (mines are just awful), a cool prompt or some nice presentation video for clifm. A few color schemes I made can be found here: https://github.com/leo-arch/clifm-colors

4) Clifm works on these operating systems and CPU architectures. Test it on other platforms and let us know how it performs.

5) Join our Gitter discussion room and let us know your what you think: ideas, observations, comments and questions are always welcome.

6) Of course, you can also tell your friends about clifm, write a (positive) review of it somewhere on the internet, or you can just create a nice t-shirt with our logo to tell the world how great clifm is (just kidding, or not).

7) Buy me a beer or become a sponsor.