Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 3.3 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 (CLA). 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.

Community Guidelines

This project follows Google's Open Source Community Guidelines.

Development guide

Get set up

  1. Clone this repository (or a fork).
  2. At the project root, install all modules by running npm install.

Creating a Pull Request

Note: You must build from source and check in any changes to the contents of the bin directory.

  1. Before creating a pull request, run the following commands to lint, build, and test your changes:

    # run the linter
npm run format:check

# rebuild source
npm run build

# run unit tests
npm run test

  2. If you've forked the repo and want to watch the action run, add secrets to your forked repo that match the secrets specified in one of the workflow files you want to test, and trigger the workflow in your forked repo (for example, by creating a pr or pushing to the main branch)

  3. Once you're confident in your changes, create a pull request against the firebaseextended/action-hosting-deploy repo.

Publishing a new version

A repo owner can publish a new version of the action by following the instructions in the GitHub docs. Manual releases should follow the convention of our existing releases, like v0.4-alpha.

The current major version is v0. We move this tag up to the latest release using the method recommended by GitHub.

It is important to note that firebase-tools references v0, so any change in the major version should have a linked firebase-tools PR.