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://bitbucket.org/timcera/toolbox_utils/issues?status=new&status=open

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 bitbucket issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the bitbucket issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

TSToolbox could always use more documentation, whether as part of the official TSToolbox 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://bitbucket.org/timcera/toolbox_utils

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 toolbox_utils for local development.

Fork the toolbox_utils repo on bitbucket at https://bitbucket.org/timcera/toolbox_utils/fork.

Clone your fork locally:

$ git clone git@bitbucket.org:your_bitbucket_login/toolbox_utils.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv toolbox_utils
$ cd toolbox_utils
$ python setup.py develop
```

For testing you also need to install tox, coverage, and flake8:

$ pip install tox
$ pip install coverage
$ pip install flake8

Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ tox
```
Bring the htmlcov/index.html file up into a browser to make sure that the code has appropriate test coverage.

Commit your changes and push your branch to bitbucket:

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

Submit a pull request through the bitbucket website.

Pull Request Guidelines¶

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

The pull request should include tests.
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.
The pull request should work for Python 3.5, 3.6, 3.7