Guidelines

opensas edited this page Apr 3, 2012 · 2 revisions
Clone this wiki locally

Contributor Guidelines

Esta página todavía no ha sido traducida al castellano. Puedes ayudarnos con la tarea simplemente presionando el botón Edit Page. Para más información puedes leer esta guía para el traductor. Aquí puedes ver cuánto nos falta para terminar la traducción.

Implementation-wise, the following things should be avoided as much as possible:

  • public mutable state
  • global state
  • implicit conversions
  • threadLocal
  • locks
  • casting

Also, be careful with introducing new, heavy external dependencies.

source format

  • run scalariform-format before commit

git commits

  • prefer rebase
  • bigger changesets

API design

  • java only APIs should go to framework/play/src/main/java, package structure is play.myapipackage.xxxx
  • java and scala APIs should be implemented the following way:
    • implement the core API in scala
    • if your component requires life cycle management or needs to be swappable, create a plugin, otherwise skip this step
    • wrap core API for scala users (example)
    • wrap scala API for java users (example)

Testing and documentation

  • each and every public facing method and class need to have a corresponding scaladoc or javadoc with examples, description etc.
  • each feature requires either a functional test (framework/integrationtest) or a spec (/play/src/test)
  • run Play's integration test suite framework/runtests before pushing. If a test fails, fix it, do not ignore it.