Skip to content
Back to top
View this page

# Contributing guidelines

So you’re interested in contributing to marshmallow or one of our associated projects? That’s awesome! We welcome contributions from anyone willing to work in good faith with other contributors and the community (see also our Code of Conduct).

## Security contact information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

## Questions, feature requests, bug reports, and feedback…

…should all be reported on the Github Issue Tracker .

## Ways to contribute

- Comment on some of marshmallow’s open issues (especially those labeled “feedback welcome”). Share a solution or workaround. Make a suggestion for how a feature can be made better. Opinions are welcome!

- Improve the docs. For straightforward edits, click the ReadTheDocs menu button in the bottom-right corner of the page and click “Edit”. See the Documentation section of this page if you want to build the docs locally.

- If you think you’ve found a bug, open an issue.

- Contribute an example usage of marshmallow.

- Send a PR for an open issue (especially one labeled “help wanted”). The next section details how to contribute code.

## Contributing code

### Setting up for local development

1. Fork marshmallow on Github.

    $ git clone https://github.com/marshmallow-code/marshmallow.git
    $ cd marshmallow

2. Install development requirements. It is highly recommended that you use a virtualenv. Use the following command to install an editable version of marshmallow along with its development requirements.

    # After activating your virtualenv
    $ pip install -e '.[dev]'

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 --allow-missing-config

### Git branch structure

marshmallow abides by the following branching model:

`dev`

  Current development branch. New features should branch off here.

`X.Y-line`

  Maintenance branch for release `X.Y`. Bug fixes should be sent to the most recent release branch. A 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.

For a new feature:

    $ git checkout -b name-of-feature dev

For a bugfix:

    $ git checkout -b fix-something 3.x-line

2. Commit your changes. Write good commit messages.

    $ git commit -m "Detailed commit message"
    $ git push origin name-of-feature

3. 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`.

4. Submit a pull request to `marshmallow-code:dev` or the appropriate maintenance branch. The CI build must be passing before your pull request is merged.

### Running tests

To run all tests:

    $ pytest

To run formatting and syntax checks:

    $ tox -e lint

(Optional) To run tests in all supported Python versions in their own virtual environments (must have each interpreter installed):

    $ tox

### Documentation

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

To build and serve the docs in “watch” mode:

    $ tox -e docs-serve

Changes to documentation will automatically trigger a rebuild.

### Contributing examples

Have a usage example you’d like to share? A custom `Field` that others might find useful? Feel free to add it to the examples directory and send a pull request.