Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
48 lines (30 sloc) 2.04 KB

Contributing

Fork and clone the repository:

git clone git@github.com:your-username/pymanopt.git

Verify that all existing tests pass by either running

python setup.py test

or executing the test suite via nose:

nosetests

Note that we also run the pep8 utility on every python file in the package to verify coding style consistency. As such, failure to comply to the style guide will result in a failing travis-ci build.

Push a feature branch to your fork and submit a pull request. Refer to this guide on how to write good commit messages.

Sign-off

By making a contribution (pull requesting or committing) to the Pymanopt project you certify that

  • you have the right to submit it to Pymanopt.

  • you created the contribution/modification; or you based it on previous work that, to the best of your knowledge, is covered by a compatible open source license; or someone who did one of the former provided you with this contribution/modification and you are submitting it without changes.

  • you understand and agree that your contribution/modification to this project is public and that a record of it (including all information you submit with it, including copyright notices and your sign-off) is maintained indefinitely and may be redistributed consistent with Pymanopt's 3-clause BSD license or the open source license(s) involved.

To make your certification explicit we borrow the "sign-off" procedure from the Linux kernel project, i.e., each commit message should contain a line saying

Signed-off-by: Name Sirname <name.sirname@example.org>

using your real name and email address. Running the git-commit command with the -s option automatically adds this line.