Skip to content

Latest commit

 

History

History
89 lines (63 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

89 lines (63 loc) · 2.25 KB
Raw

How to contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution, this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Setup local environment

Clone the project and run the following commands to setup your environment

python3.11 -m venv venv
source venv/bin/activate 
pip3 install --upgrade pip 
python3.11 -m pip install -e ".[dev]"

(this also applies to setting up samples environment for each sample)

Running tests

Without coverage:

python3.11 -m pytest

With coverage:

python3.11 -m pytest --cov=src --cov-report term --cov-report html --cov-report xml -vv

Formatting code

yapf -i -r -p .

Running lints & type checking

# Type checking
python3.11 -m mypy .
# Linting
python3.11 -m pylint $(git ls-files '*.py')

Generating Docs

Prerequisites:

  • On OSX, install getopt:
    • brew install gnu-getopt
./docs/generate.sh --out=./docs/build/ --pypath=src/

Deploying a sample for testing

Example:

cd samples/basic_https
firebase deploy --only=functions

Note to test your local changes of firebase-functions when deploying you should push your changes to a branch on GitHub and then locally in the sample/*/requirements.txt change firebase-functions dependency line to instead come from git, e.g. :

git+https://github.com/YOUR_USERNAME/firebase-functions-python.git@YOURBRANCH#egg=firebase-functions