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/whiskml/whisk/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¶

whisk could always use more documentation, whether as part of the official whisk 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/whiskml/whisk/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 whisk for local development.

Fork the whisk repo on GitHub.

Clone your fork locally:

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

Install your local copy into a venv. This is how you set up your fork for local development:

$ cd whisk/
$ python3 -m venv venv
$ source venv/bin/activate
$ python setup.py develop
$ pip install -r requirements_dev.txt

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 whisk tests
$ pytest -s --ignore=whisk/template
$ tox
```

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

Submit a pull request through the GitHub website.

Creating a demo project¶

To create a demo project from your local fork of whisk:

Set the following environment variables:

PROJECT_DEMO_DIR # The directory where the demo project will be created PROJECT_DEMO_NAME # The name of the project
Then run the make task:

$ make create-demo

make create-demo deletes the existing demo project (if it exists) and creates a new project.

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.6, 3.7 and 3.8, and for PyPy. Check https://app.circleci.com/pipelines/github/whisk-ml/whisk and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ pytest tests/test_whisk.py

Testing the source code vs. the package¶

When running pytest, you are testing the source code in the current venv. When running tox, you are testing the package generated by python setup.py sdist. It’s important to run tox as it runs test against the package other users will install. tox can fail even if pytest succeeds because of an incorrect MANIFEST.in file or missing dependencies within the setup.py install_requires argument.

Checking MANIFEST.in¶

It’s easy to add files to version control but forget to include in the MANIFEST.in file. After committing changes, run the following to see if any files are missing:

$ check-manifest

Updating the getting started notebook¶

The project contains a notebook to help orientate new users. You can modify this notebook in the demo project and update the template with:

$ make update-notebook

Deploying¶

Make sure all your changes are pushed (including an entry in HISTORY.rst) and pass CI tests. Then run:

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags
$ make release

We intended to have CircleCI perform the release, but it’s having issues with git tags. https://discuss.circleci.com/t/jobs-triggered-by-annotated-tags-fail-when-using-built-in-git-client/34486

If doing a small patch, you can just run:

$ make bump-push release

CI Setup - Required environment variables¶

GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME PYPI_PASSWORD PYPI_USERNAME