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#

If you are reporting a bug, please include:

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

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

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

The best way to send feedback is to file an issue at gucky92/dreye#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 :)

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

Clone your fork locally:

$ git clone git@github.com:your_name_here/dreye.git

Install your local copy into a virtualenv or a conda environment. Assuming you have virtualenvwrapper or conda installed (called dreye), this is how you set up your fork for local development:
```
$ mkvirtualenv dreye or conda activate dreye
$ cd dreye/
$ python setup.py develop
```
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:
```
$ flake8 dreye tests
$ python setup.py test or pytest
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

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

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. Provide a tutorial in the form of an annotated .ipynb file and add it to docs/source/user_guide/tutorials.
The pull request should work for Python 3.6, 3.7 and 3.8, and for PyPy. Check https://travis-ci.com/gucky92/dreye/pull_requests and make sure that the tests pass for all supported Python versions.

TODO