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/FrictionTribologyEnigma/SlipPY/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. Alternatively if you have a working code example of a feature you would like added please file an issue with the code attached.

Write Documentation

SlipPY could always use more documentation, whether as part of the official SlipPY docs, in docstrings, or even on the web in blog posts, articles, and such. We also have a set of examples any contribution to these would be greatly appreciated.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/FrictionTribologyEnigma/SlipPY/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 :)

  • A working example of the functionality in any language will help

Get Started!

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

  1. Fork the slippy repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/slippy.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 slippy
$ cd slippy/
$ 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 (code style), the tests (code functionality) and test that the documentations will still compile:

    $ flake8 slippy tests
$ python setup.py test or pytest
$ sphinx-build doc build

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

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

    $ git add .
$ git commit -m "A 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 of the functionality you added or the bug which was fixed, this will ensure that it is not accidentally broken in future releases.

  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function or class with a docstring, add a reference to it in the docstring of slippy.surface.__init__.py or slippy.contact.__init__.py and add the feature to the list in README.rst.

  3. Flake8 and pytest tests all pass, please run tests locally to reduce the load/ cost of the automated testing service.

Deploying

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

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

Travis will then deploy to PyPI if tests pass.