Skip to content

Latest commit

 

History

History
154 lines (100 loc) · 9.51 KB

CONTRIBUTING.md

File metadata and controls

154 lines (100 loc) · 9.51 KB
Raw

Contributing to the Firebase JS SDK

We'd love for you to contribute to our source code and to help make the Firebase JS SDK even better than it is today! Here are the guidelines we'd like you to follow:

Code of Conduct

As contributors and maintainers of the Firebase JS SDK project, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities.

Communication through any of Firebase's channels (GitHub, StackOverflow, Google+, Twitter, etc.) must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to the project to do the same.

If any member of the community violates this code of conduct, the maintainers of the Firebase JS SDK project may take action, removing issues, comments, and PRs or blocking accounts as deemed appropriate.

If you are subject to or witness unacceptable behavior, or have any other concerns, please drop us a line at firebase-code-of-conduct@google.com.

Got a Question?

If you have questions about how to use the Firebase JS SDK, please direct these to StackOverflow and use the firebase and javascript tags. You can also use the Firebase Google Group or Slack to contact members of the Firebase team for help.

Found an Issue?

If you find a bug in the source code, a mistake in the documentation, or some other issue, you can help us by submitting an issue to our GitHub Repository. Even better you can submit a Pull Request with a test demonstrating the bug and a fix!

See below for some guidelines.

Production Issues

If you have a production issue, please contact Firebase support who will work with you to resolve the issue.

Submission Guidelines

Submitting an Issue

Before you submit your issue, try searching past issues, StackOverflow, and the Firebase Google Group for issues similar to your own. You can help us to maximize the effort we spend fixing issues, and adding new features, by not reporting duplicate issues.

If your issue appears to be a bug, and hasn't been reported, open a new issue. Providing the following information will increase the chances of your issue being dealt with quickly:

  • Description of the Issue - if an error is being thrown a non-minified stack trace helps
  • Motivation for or Use Case - explain why this is a bug for you
  • Related Issues - has a similar issue been reported before?
  • Environment Configuration - is this a problem with Node.js, or only a specific browser? Is this only in a specific version of the SDK?
  • Reproduce the Error - provide a live example (like JSBin), a Github repo, or an unambiguous set of steps
  • Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

There is an issue template provided to help capture all of this information. Following the template will also help us to route your issue to the appropriate teams faster, helping us to better help you!

Also as a great rule of thumb:

If you get help, help others. Good karma rulez!

Submitting a Pull Request

Before you contribute

Before we can use your code, you must sign the Google Individual Contributor License Agreement (CLA), which you can do online. The CLA is necessary mainly because you own the copyright to your changes, even after your contribution becomes part of our codebase, so we need your permission to use and distribute your code. We also need to be sure of various other things, for instance, that you'll tell us if you know that your code infringes on other people's patents. You don't have to sign the CLA until after you've submitted your code for review and a member has approved it, but you must do it before we can put your code into our codebase. There is also a nifty CLA bot that will guide you through this process if you are going through it for the first time.

Before you start working on a larger contribution, you should get in touch with us first through the issue tracker with your idea so that we can help out and possibly guide you. Coordinating up front makes it much easier to avoid frustration later on. Some pull requests (large contributions, API additions/changes, etc) may be subject to additional internal review, we appreciate your patience as we fully validate your contribution.

Pull Request Guidelines

  • Search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.

  • Create an issue to discuss a change before submitting a PR. We'd hate to have to turn down your contributions because of something that could have been communicated early on.

  • Create a fork of the GitHub repo to ensure that you can push your changes for us to review.

  • Make your changes in a new git branch:

    git checkout -b my-fix-branch master

  • Create your patch, including appropriate test cases. Patches with tests are more likely to be merged.

  • Avoid checking in files that shouldn't be tracked (e.g node_modules, gulp-cache, .tmp, .idea). If your development setup automatically creates some of these files, please add them to the .gitignore at the root of the package (click here to read more on how to add entries to the .gitignore).

  • Commit your changes using a commit message that follows our commit message guidelines.

    git commit -a

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  • Test your changes locally to ensure everything is in good working order:

    npm test

  • Push your branch to your fork on GitHub:

    git push origin my-fix-branch

  • In GitHub, send a pull request to firebase-js-sdk:master.

  • All pull requests must be reviewed by a member of the Firebase JS SDK team, who will merge it when/if they feel it is good to go.

That's it! Thank you for your contribution!

Updating Documentation

Reference docs for the Firebase JS SDK and Node (client) SDK are generated by Typedoc.

Typedoc generates this documentation from the main firebase index.d.ts type definition file. Any updates to documentation should be made in that file.

If any pages are added or removed by your change (by adding or removing a class or interface), the js/toc.yaml and/or node/toc.yaml need to be modified to reflect this.

Generating Documentation HTML Files

In order to generate the HTML documentation files locally, go to the root of this repo, and run:

yarn install
yarn docgen

This will generate both js and node (client) reference docs. To just generate js docs, replace the last line with:

yarn docgen:js

To just generate node docs, replace the last line with:

yarn docgen:node

Files will be written to scripts/docgen/html - js docs will go into the /js subdirectory and node docs into the /node subdirectory.

NOTE: These files are formatted to be inserted into Google's documentation site, which adds some styling and navigation, so the raw files will be missing navigation elements and may not look polished. However, it should be enough to preview the content.

This process will generate warnings for files that are generated but not listed in the toc.yaml, or files that are in the toc.yaml but were not generated (which means something is missing in index.d.ts). If this happens during the JS documentation generation, it probably means either the toc.yaml or index.d.ts is incorrect. But in the Node process, some generated files not being found in toc.yaml are to be expected, since Node documentation is a subset of the full JS documentation.

Follow the PR submission guidelines above to submit any documentation changes.