Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

60 lines (38 loc) · 3.24 KB
Raw

Contributing

It's great to receive contributions from the community! If you'd like to contribute to this project, make sure to review and follow the guidelines below.

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 agreement 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 and copy 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.

Report an issue

Report all issues through GitHub Issues using the Report a Bug template.

To help resolve your issue as quickly as possible, read the template and provide all the requested information.

File a feature request

We welcome all feature requests, whether it's to add new functionality to an existing extension or to offer an idea for a brand new extension.

Here's how to submit a feature request for an existing extension:

  1. File your feature request through GitHub Issues using the Feature Request template.

  2. File a new Firebase support request via the Firebase website. Make sure to reference your feature request's GitHub Issue in the support ticket.

Create a pull request

When making pull requests to the repository, make sure to follow these guidelines for both bug fixes and new features:

  • Before creating a pull request, file a GitHub Issue so that maintainers and the community can discuss the problem and potential solutions before you spend time on an implementation.

  • In your PR's description, link to any related issues or pull requests to give reviewers the full context of your change.

  • For commit messages, follow the Conventional Commits format.

    • For example, if you update documentation for a specific extension, your commit message might be: docs(extension-name) updated installation documentation.

  • For your PR to be merged:

Features

Before creating pull requests for new features, first file a GitHub Issue describing the reasoning and motivation for the feature. This gives maintainers and the community the opportunity to provide feedback on your idea before implementing it.