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 here

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#

The package could always use more documentation, whether as part of the official package 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.

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

  1. Fork the repo.

  2. Clone your fork locally:

git clone git@github.com:your_name_here/minifold.git

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

mkvirtualenv minifold
cd minifold/
python setup.py develop

  1. Install flake8 and tox in you virtualenv:

pip install flake8 tox

  1. Create a branch for local development to make your changes locally:

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

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

flake8 minifold tests
python setup.py test or pytest
tox

  1. 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

  1. 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.6. Check the GitHub actions and make sure that the tests pass for all supported Python versions.

Tips#

To run a subset of tests:

pytest tests.test_foo

Deploying#

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.md). Then run:

bumpversion patch # possible: major / minor / patch
git push
git push --tags

GitHub will then deploy to PyPI if tests pass.