Contributing

ELI5 uses MIT license; contributions are welcome!

ELI5 supports Python 2.7 and Python 3.4+ To run tests make sure tox Python package is installed, then run

tox

from source checkout.

We like high test coverage and mypy type annotations.

Making releases

Note: releases are made from master by eli5 maintainers. When contributing a pull request, please do not update release notes or package version.

To make a new release:

  • Write a summary of changes to CHANGES.rst
  • Bump version in eli5/__init__.py
  • Make a release on PyPI using twine
  • Tag a commit in git and push it