Contributing guide

mmappickle is a free software, and all contributions are welcome, whether they are bug reports, source code, or documentation.

Reporting bugs

To report bugs, open an issue in the issue tracker.

Ideally, a bug report should contain at least the following information:

  • a minimum code example to trigger the bug
  • the expected result
  • the result obtained.

Quick guide to contributing code or documentation

To contribute, you’ll need Sphinx to build the documentation, and pytest to run the tests.

If for some reason you are not able to run the following steps, simply open an issue with your proposed change.

  1. Fork the mmappickle on GitHub.
  2. Clone your fork to your local machine:
git clone https://github.com/<your username>/mmappickle.git
cd mmappickle
pip install -e .
  1. Create a branch for your changes:
git checkout -b <branch-name>
  1. Make your changes.
  2. If you’re writing code, you should write some tests, ensure that all the tests pass and that the code coverage is good. This can be done using:
py.test --cov=mmappickle --pep8
  1. You should also check that the documentation compiles and that the result look good. The documentation can be seen by opening a browser in doc/html. You can (re)build it using the following command line (make sure that there is no warnings):
sphinx-build doc/source doc/html
  1. Commit your changes and push to your fork on GitHub:
git add .
git commit -m "<description-of-changes>"
git push origin <name-for-changes>
  1. Submit a pull request.