Skip to content

Latest commit

 

History

History
165 lines (111 loc) · 5.49 KB

CONTRIBUTING.rst

File metadata and controls

165 lines (111 loc) · 5.49 KB
Raw

How to contribute to Flask

Thanks for considering contributing to Flask.

Support questions

Please, don't use the issue tracker for this. Check whether the #pocoo IRC channel on Freenode can help with your issue. If your problem is not strictly Werkzeug or Flask specific, #python is generally more active. Stack Overflow is also worth considering.

Reporting issues

  • Under which versions of Python does this happen? This is even more important if your issue is encoding related.
  • Under which versions of Werkzeug does this happen? Check if this issue is fixed in the repository.

Submitting patches

  • Include tests if your patch is supposed to solve a bug, and explain clearly under which circumstances the bug happens. Make sure the test fails without your patch.
  • Try to follow PEP8, but you may ignore the line-length-limit if following it would make the code uglier.

First time setup

  • Download and install the latest version of git.
  • Configure git with your username and email.
  • Make sure you have a GitHub account.
  • Fork Flask to your GitHub account by clicking the Fork button.
  • Clone your GitHub fork locally.
  • Add the main repository as a remote to update later. git remote add pallets https://github.com/pallets/flask

Start coding

  • Create a branch to identify the issue you would like to work on (e.g. 2287-dry-test-suite)
  • Using your favorite editor, make your changes, committing as you go.
  • Try to follow `PEP8`_, but you may ignore the line length limit if following it would make the code uglier.
  • Include tests that cover any code changes you make. Make sure the test fails without your patch. Run the tests..
  • Push your commits to GitHub and create a pull request.
  • Celebrate 🎉

Running the testsuite

You probably want to set up a virtualenv.

The minimal requirement for running the testsuite is pytest. You can install it with:

pip install pytest

Clone this repository:

git clone https://github.com/pallets/flask.git

Install Flask as an editable package using the current source:

cd flask
pip install --editable .

Running the testsuite

The minimal requirement for running the testsuite is pytest. You can install it with:

pip install pytest

Then you can run the testsuite with:

pytest tests/

Shortcut: make test will ensure pytest is installed, and run it.

With only pytest installed, a large part of the testsuite will get skipped though. Whether this is relevant depends on which part of Flask you're working on. Travis is set up to run the full testsuite when you submit your pull request anyways.

If you really want to test everything, you will have to install tox instead of pytest. You can install it with:

pip install tox

The tox command will then run all tests against multiple combinations Python versions and dependency versions.

Shortcut: make tox-test will ensure tox is installed, and run it.

Running test coverage

Generating a report of lines that do not have unit test coverage can indicate where to start contributing. pytest integrates with coverage.py, using the pytest-cov plugin. This assumes you have already run the testsuite (see previous section):

pip install pytest-cov

After this has been installed, you can output a report to the command line using this command:

pytest --cov=flask tests/

Generate a HTML report can be done using this command:

pytest --cov-report html --cov=flask tests/

Full docs on coverage.py are here: https://coverage.readthedocs.io

Shortcut: make cov will ensure pytest-cov is installed, run it, display the results, and save the HTML report.

Caution

pushing

This repository contains several zero-padded file modes that may cause issues when pushing this repository to git hosts other than github. Fixing this is destructive to the commit history, so we suggest ignoring these warnings. If it fails to push and you're using a self-hosted git service like Gitlab, you can turn off repository checks in the admin panel.

cloning

The zero-padded file modes files above can cause issues while cloning, too. If you have

[fetch]
fsckobjects = true

or

[receive]
fsckObjects = true

set in your git configuration file, cloning this repository will fail. The only solution is to set both of the above settings to false while cloning, and then setting them back to true after the cloning is finished.