Contributing Guidelines

In General

  • PEP 8, when sensible.
  • Test ruthlessly. Write docs for new features.
  • Even more important than Test-Driven Development–Human-Driven Development.

In Particular

Questions, Feature Requests, Bug Reports, and Feedback…

…should all be reported on the Github Issue Tracker .

Setting Up for Local Development

  1. Fork marshmallow-jsonapi on Github.

    $ git clone
    $ cd marshmallow-jsonapi
  2. Install development requirements. It is highly recommended that you use a virtualenv.

    # After activating your virtualenv
    $ pip install -r dev-requirements.txt
  3. Install the pre-commit hooks, which will format and lint your git staged files.

    # The pre-commit CLI was installed above
    $ pre-commit install

Git Branch Structure

Marshmallow abides by the following branching model:

Current development branch. New features should branch off here.
Maintenance branch for release X.Y. Bug fixes should be sent to the most recent release branch. The maintainer will forward-port the fix to dev. Note: exceptions may be made for bug fixes that introduce large code changes.

Always make a new branch for your work, no matter how small. Also, do not put unrelated changes in the same branch or pull request. This makes it more difficult to merge your changes.

Pull Requests

1. Create a new local branch.

$ git checkout -b name-of-feature dev

2. Commit your changes. Write good commit messages.

$ git commit -m "Detailed commit message"
$ git push origin name-of-feature
  1. Before submitting a pull request, check the following:
  • If the pull request adds functionality, it is tested and the docs are updated.
  • You’ve added yourself to AUTHORS.rst.
  1. Submit a pull request to marshmallow-code:dev or the appropriate maintenance branch. The Travis CI build must be passing before your pull request is merged.

Running tests

To run all tests:

$ invoke test

To run tests on Python 2.7, 3.5, and 3.6 virtual environments (must have each interpreter installed):

$ tox


Contributions to the documentation are welcome. Documentation is written in reStructured Text (rST). A quick rST reference can be found here. Builds are powered by Sphinx.

To install the packages for building the docs:

$ pip install -r docs/requirements.txt

To build the docs:

$ invoke docs -b

The -b (for “browse”) automatically opens up the docs in your browser after building.