Skip to content

Contributing Guide

Thank you for contributing to APIFlask.

Support questions

Please don't use the issue tracker for this. The issue tracker is a tool to address bugs and feature requests in APIFlask itself. Use one of the following resources for questions about using APIFlask or issues with your own code:

  • Search with Google first using: site:stackoverflow.com apiflask {search term, exception message, etc.}.
  • Ask on our GitHub Discussion, create a discussion under the "Q&A" category.
  • Ask on Stack Overflow.

Include the following information in your post:

  • Describe what you expected to happen.
  • If possible, include a minimal reproducible example to help us identify the issue. This also helps check that the issue is not with your own code.
  • Describe what actually happened. Include the full traceback if there was an exception.
  • List your Python, Flask and APIFlask versions. If possible, check if this issue is already fixed in the latest releases or the latest code in the repository.

Reporting issues

If you find a bug related to APIFlask itself, or you think APIFlask should provide a new feature/enhacement, feel free to create an issue on our issue tracker.

Include the following information in your post:

  • Describe what you expected to happen.
  • If possible, include a minimal reproducible example to help us identify the issue. This also helps check that the issue is not with your own code.
  • Describe what actually happened. Include the full traceback if there was an exception.
  • List your Python, Flask and APIFlask versions. If possible, check if this issue is already fixed in the latest releases or the latest code in the repository.

Submitting patches

If there is not an open issue for what you want to submit, prefer opening one for discussion before working on a PR. You can work on any issue that doesn't have an open PR linked to it or a maintainer assigned to it. These show up in the sidebar. No need to ask if you can work on an issue that interests you.

Include the following in your patch:

  • Include tests if your patch adds or changes code. Make sure the test fails without your patch.
  • Update any relevant docs pages and docstrings. Docs pages and docstrings should be wrapped at 72 characters.
  • Add an entry in CHANGES.md. Use the same style as other entries. Also include Version Changed or Version Added section in relevant docstrings.

First time setup

  • Download and install the latest version of Git.
  • Configure git with your username and email.
$ git config --global user.name 'your name'
$ git config --global user.email 'your email'
  • Make sure you have a GitHub account.
  • Click the "Fork" button to fork APIFlask on GitHub.
  • Clone your fork repository locally (replace {username} with your username):
$ git clone https://github.com/{username}/apiflask
$ cd apiflask
$ git remote add upstream https://github.com/greyli/apiflask
  • Create a virtual environment and install requirements:

For Linux/macOS:

$ python3 -m venv env
$ source env/bin/activate
$ python -m pip install --upgrade pip setuptools
$ pip install -r requirements/dev.txt
$ pip install -e .
$ pre-commit install

For Windows:

> python -m venv env
> env\Scripts\activate
> python -m pip install --upgrade pip setuptools
> pip install -r .\requirements\dev.txt
> pip install -e .
> pre-commit install

Start coding

  • Create a new branch to address the issue you want to work on (be sure to update the example branch name):
$ git fetch upstream
$ git checkout -b your-branch-name upstream/main
  • Using your favorite editor, make your changes, committing as you go.
  • Include tests that cover any code changes you make. Make sure the test fails without your patch. Run the tests as described below.
  • Push your commits to your fork on GitHub:
$ git push --set-upstream origin your-branch-name

Running the tests

Run the basic test suite with pytest:

$ pytest

This runs the tests for the current environment, which is usually sufficient. You can run the full test suite (including checks for unit test, test coverage, code style, mypy) with tox:

$ tox

Building the docs

Serve the live docs with MkDocs:

$ mkdocs serve

You can also build the HTML docs to preview:

$ mkdocs build

Open site/index.html in your browser to view the docs.