Skip to content

Latest commit

 

History

History
181 lines (137 loc) · 7.25 KB

CONTRIBUTING.md

File metadata and controls

181 lines (137 loc) · 7.25 KB
Raw

Contributing to AngularFire

We would love for you to contribute to AngularFire and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:

Code of Conduct

Help us keep the Angular and Firebase communities open and inclusive. Please read and follow the Angular Code of Conduct.

Got a Question or Problem?

If you have questions about how to use AngularFire, please direct them to the Angular Google Group discussion list or StackOverflow (include the firebase and angular tags!). Please note that the Angular team's capacity to answer usage questions is limited. Members of the Firebase team can be reached on Slack and via the Firebase Google Group.

Found an Issue?

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Want a Feature?

You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:

  • For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
  • Small Features can be crafted and directly submitted as a Pull Request.

Initial Setup

  1. Create a fork of AngularFire (See Forking a Project)

  2. CD into your clone and install dependencies

$ git clone 
$ npm install
$ npm run build
$ npm test
  1. Make your changes in a new git branch:
git checkout -b my-fix-branch master

Submission Guidelines

Submitting an Issue

Help us to maximize the effort we can spend improving the product by not reporting duplicate issues. Search the archives before you submit.

Providing the following information will increase the chances of your issue being dealt with quickly:

  • Overview of the Issue - if an error is being thrown a non-minified stack trace helps
  • Angular Version - what version of Angular, Firebase, and AngularFire are you using?
  • Motivation for or Use Case - explain what are you trying to do and why the current behavior is a bug for you
  • Browsers and Operating System - is this a problem with all browsers?
  • Reproduce the Error - provide a live example (using Plunker, JSFiddle or Runnable) or a unambiguous set of steps
  • Related Issues - has a similar issue been reported before?
  • 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)

You can file new issues by providing the above information here.

Submitting a Pull Request (PR)

Before you submit:

  • Ensure proposed changes or problem have already been clearly defined and discussed in the issue tracker. We don't want you to burn time on code that isn't a good fit for the project.
  • Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.
  • Please sign our Contributor License Agreement (CLA) before sending PRs. We cannot accept code without this.
  • Review our Coding Rules (external link)
  • Review our Commit Message Guidelines (external link)

How to submit:

  • Create your patch, including appropriate test cases.

  • Follow the Angular Coding Rules.

  • Run the full test suite, as described in the [developer documentation][dev-doc], and ensure that all tests pass.

  • Commit your changes using a descriptive commit message that follows the Angular commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.

    git commit -a

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

  • Push your branch to GitHub:

    git push origin my-fix-branch

  • In GitHub, send a pull request to angular:master.

  • If we suggest changes then:

    • Make the required updates.

    • Re-run the test suites to ensure tests are still passing.

    • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

      git rebase master -i
git push -f

That's it! Thank you for your contribution!

Deploying Docs

  1. Build the docs

$ npm run docs

  1. Deploy Docs to Firebase Hosting

(Ask @jeffbcross to add you as a collaborator or deploy on your behalf)

$ npm install -g firebase-tools
$ firebase login
$ npm run docs
$ cd docs
$ firebase deploy

Signing the CLA

Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code changes to be accepted, the CLA must be signed. It's a quick process, we promise!