Licence

The Play framework source code is released under the Apache 2 licence.

Reporting bugs

We use Lighthouse as issue tracker. Bug reports are incredibly helpful, so take time to report bugs and request features in our ticket tracker. We’re always grateful for patches to Play’s code. Indeed, bug reports with attached patches will get fixed far quickly than those without any.

Getting the code

Play framework is hosted on Github using the Git version control system. You can get the code with the following command:

git clone git://github.com/playframework/play.git

The project history is pretty big. You can pull only a shallow clone by specifying the number of commits you want with —depth:

git clone git://github.com/playframework/play.git --depth 10

Building from source

You need Ant to build the Play framework. Just en enter the framework/ directory and run:

ant

That's all! If you want run the test suite on your computer, just run:

ant test

Contributing

The best ways to contribute are by finding and reporting bugs, writing tests for bugs, and improving the documentation. We’re always grateful for patches to Play’s code. Indeed, bug reports with attached patches will get fixed far quickly than those without.

If you want to change the code, be careful follow our design-decisions. Be especially careful not to break compatibility with modules and older versions, or to increase complexity if you don't have a really good reason.

You have a patch? Check the contributor guide.