Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
97 lines (69 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

97 lines (69 loc) · 2.55 KB

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 install uv (our package manager):

# Install uv (if not already installed). You can also use 'pip install uv'.
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone and setup the project
git clone https://github.com/firebase/firebase-functions-python.git
cd firebase-functions-python
uv sync

This will automatically:

  • Create a virtual environment
  • Install all runtime and development dependencies
  • Use the Python version specified in .python-version (3.10)

(For samples, you can use the same approach but run uv sync in each sample directory)

Running tests

Without coverage:

uv run pytest

With coverage:

uv run pytest --cov=src --cov-report term --cov-report html --cov-report xml -vv

Formatting code

uv run ruff format .

Running lints & type checking

# Type checking
uv run mypy .
# Linting
uv run ruff check .

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