Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 1.65 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.

Testing

Unit Tests

All pull requests should have an associated test to ensure foward compatibility.

To run an individual test, you can run a command such as the following:

npm run test -- -g 'loading function'

Manual Testing

When developing a feature locally, you can install a local version of the Functions Framework using npm link. First compile your local clone of the Functions Framework:

npm compile

Then link the Functions Framework using npm link.

npm link

You can then run the Functions Framework locally using functions-framework.

Community Guidelines

This project follows Google's Open Source Community Guidelines.