Contributing to Elwood

Contributions to Elwood are welcome. Please read the following guidelines before contributing.

General Guidelines

  • Please follow the style of the code you are modifying.

  • Please add tests for any new features.

  • Please add documentation for any new features.

  • Please add a changelog entry for any new features.

  • Please add yourself to the list of contributors in the README.md file.

Getting Started with Development

See installation for instructions on building repository from source for local development.

Running Elwood’s Test Suite

Elwood uses pytest for testing. If you have an Elwood container or have the Elwood source code with all dependencies installed, you can run pytest directly:

$ pytest -vs