Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/paulross/TotalDepth/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

TotalDepth could always use more documentation, whether as part of the official TotalDepth docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/paulross/TotalDepth/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up TotalDepth for local development.

  1. Fork the TotalDepth repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:paulross/TotalDepth.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv TotalDepth
$ cd TotalDepth/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 TotalDepth tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 3.3 and above (we don’t support Python 2.x), and for PyPy. Check https://travis-ci.org/paulross/TotalDepth/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ pytest tests.test_TotalDepth

Release Checklist

In the following example the version we are moving to, in Major.Minor.Patch format, is 0.2.1.

Current version should be something like M.m.(p)rcX, for example 0.2.1rc0.

Increment version

Change the version to M.m.p in these places:

  • setup.cfg
  • setup.py
  • src/TotalDepth/__init__.py
  • /docs/source/conf.py (two places).

In src/TotalDepth/__init__.py change VERSION = (0, 2, 1)

Update the history:

  • HISTORY.rst
  • src/TotalDepth/__init__.py

Update any Trove classifiers in setup.py, https://pypi.python.org/pypi?%3Aaction=list_classifiers

Build and Test

Build

Build, in this case for Python 3.6:

$ python3.6 -m venv ~/venvs/TotalDepth_00/
$ . ~/venvs/TotalDepth_00/bin/activate
(TotalDepth_00) $ pip install --upgrade pip
(TotalDepth_00) $ pip install --user --upgrade setuptools wheel
(TotalDepth_00) $ pip install -r requirements.txt
(TotalDepth_00) $ python setup.py develop

Test

As a minimal test:

(TotalDepth_00) $ pytest tests/

This should take under a minute.

A full test:

(TotalDepth_00) $ pytest --runslow tests/

This can take 10 to 30 minutes.

Build a Development Environment

This includes the full testing (including test coverage) and documentation environment.

As above plus:

(TotalDepth_00) $ pip install -r requirements-dev.txt

Test Coverage

With test coverage:

(TotalDepth_00) $ pytest --cov=TotalDepth --cov-report html tests --runslow

This can take 10 to 30 minutes.

Documentation

Build the docs HTML to test them, from an environment that has Sphinx:

(Sphinx) $ cd docs
(Sphinx) $ make clean
(Sphinx) $ make html

Commit and Tag

Commit, tag and push:

$ git add .
$ git commit -m 'Release version 0.2.1'
$ git tag -a v0.2.1 -m 'Version 0.2.1'
$ git push
$ git push origin v0.2.1

PyPi

Prepare release to PyPi for Python 3.6:

Build the egg and the source distribution:

(TotalDepth_00) $ python setup.py install sdist

Check the contents of dist/*, unpack into tmp/ if you want:

$ cp dist/* tmp/
$ cd tmp/
$ unzip TotalDepth-0.2.1-py3.6-macosx-10.6-intel.egg -d py27egg
$ tar -xzf TotalDepth-0.2.1.tar.gz

Release to PyPi, https://pypi.python.org/pypi/TotalDepth:

(TotalDepth_00) $ twine upload dist/*

ReadTheDocs

Build the documentation: https://readthedocs.org/projects/TotalDepth/builds/

Prepare Next Release Candidate

Finally change the version to M.m.(p+1)rc0, in this example 0.2.2rc0 in these places:

  • setup.cfg
  • setup.py
  • src/TotalDepth/__init__.py
  • /docs/source/conf.py (two places).

In src/TotalDepth/__init__.py change VERSION = (0, 2, 2, 'rc0')

Commit and push:

$ git add .
$ git commit -m 'Release candidate v0.2.2rc0'
$ git push