Contributing to Womack

Womack development is hosted on github. If you want to contribute to Womack, fork the project and follow the quickstart steps to try it out. Then you might want to:

Install the development requirements

Run make dev to install the default, server, test and docs requirements.

Run tests

Womack uses tox, nose2 and selenium to run its tests. There are unit tests for the python code, and functional tests for the full system.

• To run unit tests: tox (or make test)

• To run functional tests: tox -e func (or make functional-test)

  Warning

  The functional tests are pretty slow, and require the Firefox selenium webdriver and redis.

Compile documentation

Womack’s documetation is built with Sphinx. To compile Womack’s documentation, run make html from the top-level dir or in the docs dir. Docs are compiled to docs/_build/html.

Contribute features, fixes or documentation

Great! Here are some things you should know.

• Our python coding style standard is to stick to pep8 except where that would be egregiously ugly. In particular we prefer to avoid tabs and trailing whitespace, and keep lines to 80 characters or below.
• Our javascript coding style is:
  • Try to keep it readable.
  • Keep things out of global scope.
• Any new code must come with tests and documentation.
• Bugfixes should start with a new test (that fails) and end with that new test passing.
• We prefer that patches be submitted as pull requests.