Contributing

Pull requests are very welcome! Make sure your patches are well tested and documented :)

Development environment

See this guide to to setup a development environment using Vagrant.

And follow our coding style guide.

Running the tests

You can use make to install all tsuru dependencies and run tests. It will also check if everything is ok with your GOPATH setup:

$ make

Please ensure that MongoDB and Redis are started before running the test suite. If you see some tests failures with messages like “dial tcp 127.0.0.1:6379: connection refused” and “no reachable server”, the most likely reason is that these services are not running.

If you just want to run the tests you can use make test.

$ make test

Writing docs

tsuru documentation is written using Sphinx, which uses RST. Check these tools docs to learn how to write docs for tsuru.

Building docs

In order to build the HTML docs, just run on terminal:

$ make doc

Community

irc channel

#tsuru channel on irc.freenode.net - chat with other tsuru users and developers.

Gitter

We’re also on Gitter, check it out: https://gitter.im/tsuru/tsuru.

Release Process

tsuru major releases are guided by GitHub milestones. New releases should be generated by make release version=new-version-number.