Contributing

Contributions are welcome on this repo! Follow this guide to see how you can help.

What can I do?

There are multiple ways to give a hand on this repo:

• resolve issues already opened
• tackle new features from the roadmap
• fix typos, improve code quality, code coverage

Guidelines

Tests

tf-explain is run against Python 3.6 and 3.7, for Tensorflow beta. We use tox (available with pip) to perform the tests. All the submitted code should be unit tested (we use pytest).

To run all the tests, install required packages with pip install -e .[tests] and then run tox in a terminal.

Code Format

All code is formatted with Black (available with pip). When opening your PR, make sure your code is formatted or Travis will fail. To format your code, simply call make black.