flask-restplus is open-source and very open to contributions.
Issues are contributions in a way so don’t hesitate to submit reports on the official bugtracker.
Provide as much informations as possible to specify the issues:
- the flask-restplus version used
- a stacktrace
- installed applications list
- a code sample to reproduce the issue
Submitting patches (bugfix, features, ...)¶
If you want to contribute some code:
- fork the official flask-restplus repository
- create a branch with an explicit name (like
- do your work in it
- rebase it on the master branch from the official repository (cleanup your history by performing an interactive rebase)
- add you change to the changelog
- submit your pull-request
There are some rules to follow:
- your contribution should be documented (if needed)
- your contribution should be tested and the test suite should pass successfully
- your code should be mostly PEP8 compatible with a 120 characters line length
- your contribution should support both Python 2 and 3 (use
You need to install some dependencies to develop on flask-restplus:
$ pip install -e .[dev]
tasks.py is provided to simplify the common tasks:
$ inv -l Available tasks: all Run tests, reports and packaging assets Fetch web assets clean Cleanup all build artifacts cover Run tests suite with coverage demo Run the demo dist Package for distribution doc Build the documentation qa Run a quality report test Run tests suite tox Run tests against Python versions
To ensure everything is fine before submission, use
It will run the test suite on all the supported Python version
and ensure the documentation is generating.
You also need to ensure your code is compliant with the flask-restplus coding standards:
$ inv qa
To ensure everything is fine before commiting, you can launch the all in one command:
$ inv qa tox
It will ensure the code meet the coding conventions, runs on every version on python and the documentation is properly generating.