Skip to content

Latest commit

 

History

History
134 lines (78 loc) · 4.02 KB

CONTRIBUTING.rst

File metadata and controls

134 lines (78 loc) · 4.02 KB
Raw

Contributing Guidelines

Questions, Feature Requests, Bug Reports, and Feedback…

…should all be reported on the GitHub Issue Tracker .

Contributing Code

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

Setting Up for Local Development

  1. Fork flask-marshmallow on GitHub.
$ git clone https://github.com/marshmallow-code/flask-marshmallow.git
$ cd flask-marshmallow
  1. Install development requirements. It is highly recommended that you use a virtualenv. Use the following command to install an editable version of flask-marshmallow along with its development requirements.
# After activating your virtualenv
$ pip install -e '.[dev]'
  1. (Optional, but recommended) Install the pre-commit hooks, which will format and lint your git staged files.
# The pre-commit CLI was installed above
$ pre-commit install

Note

flask-marshmallow uses black for code formatting, which is only compatible with Python>=3.6. Therefore, the pre-commit install command will only work if you have the python3.6 interpreter installed.

Git Branch Structure

flask-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.. 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.
# For a new feature
$ git checkout -b name-of-feature dev

# For a bugfix
$ git checkout -b fix-something 1.2-line
  1. 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:

$ pytest

To run 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 the docs in "watch" mode:

$ tox -e watch-docs

Changes in the docs/ directory will automatically trigger a rebuild.

Contributing Examples

Have a usage example you'd like to share? Feel free to add it to the examples directory and send a pull request.