Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

44 lines (32 loc) · 1.48 KB
Raw

Contributing to django-tables2

You are welcome to contribute to the development of django-tables2 in various ways:

  • Discover and report bugs. Make sure to include a minimal example to show your problem.
  • Propose features, add tests or fix bugs by opening a Pull Request
  • Fix documenation or translations

When contributing code or making bug fixes, we need to have unit tests to verify the expected behaviour.

Running the tests

With tox installed, you can run the test suite by typing tox. It will take care of installing the correct dependencies. During development, you might not want to wait for the tests to run in all environments. In that case, use the -e argument to specify an environment: tox -e py27-1.11 to run the tests in python 2.7 with Django 1.11, or PYTHONPATH=. py.test to run the tests against your current environment (which is even quicker).

Code coverage

To generate a html coverage report:

PYTHONPATH=. py.test -s --cov=django_tables2 --cov-report html

Building the documentation

If you want to build the docs from within a virtualenv, and Sphinx is installed globally, use:

cd docs/
make html SPHINXBUILD="python $(which sphinx-build)"

Publishing a release

  1. Bump the version in django-tables2/__init__.py.
  2. Update CHANGELOG.md.
  3. Create a tag ./setup.py tag.
  4. Run ./setup.py publish