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

If you want to add any new driver, check out our docs for creating new splinter drivers.

running the tests

If you are using a virtualenv, all you need is:

$ make test

You can also specify one or more test files to run:

$ make test which=tests/,tests/

You can pass which test files you want to run, separated by comma, to the which variable.

some conventions we like

You can feel free to create and pull request new branches to Splinter project. When adding support for new drivers, we usually work in a separated branch.

writing docs

Splinter documentation is written using Sphinx, which uses RST. We use the Read the Docs Sphinx Theme. Check these tools’ docs to learn how to write docs for Splinter.

building docs

In order to build the HTML docs, just navigate to the project folder (the main folder, not the docs folder) and run the following on the terminal:

$ make doc

The requirements for building the docs are specified in doc-requirements.txt in the project folder.