Skip to content

Latest commit

 

History

History
100 lines (63 loc) · 4.33 KB

CONTRIBUTING.md

File metadata and controls

100 lines (63 loc) · 4.33 KB
Raw

Contribution guidelines to fxa-js-client

Anyone is welcome to help with Firefox Accounts. Feel free to get in touch with other community members on IRC, the mailing list or through issues here on GitHub.

Bug Reports

You can file issues here on GitHub. Please try to include as much information as you can and under what conditions you saw the issue.

Sending Pull Requests

Patches should be submitted as pull requests (PR).

Before submitting a PR:

  • Your code must run and pass all the automated tests before you submit your PR for review. "Work in progress" pull requests are allowed to be submitted, but should be clearly labeled as such and should not be merged until all tests pass and the code has been reviews.
    • Run grunt jshint to make sure your code passes linting.
    • Run npm test to make sure all tests still pass.
  • Your patch should include new tests that cover your changes. It is your and your reviewer's responsibility to ensure your patch includes adequate tests.

When submitting a PR:

  • You agree to license your code under the project's open source license (MPL 2.0).
  • Base your branch off the current master (see below for an example workflow).
  • Add both your code and new tests if relevant.
  • Run grunt jshint and npm test to make sure your code passes linting and tests.
  • Please do not include merge commits in pull requests; include only commits with the new relevant code.

See the main README.md for information on prerequisites, installing, running and testing.

Code Review

This project is production Mozilla code and subject to our engineering practices and quality standards. Every patch must be peer reviewed. This project is part of the Firefox Accounts module, and your patch must be reviewed by one of the listed module owners or peers.

Build Library

Note: Java is required to build the library due to a custom SJCL build.

npm run-script setup
npm start

The build directory should have fxa-client.js and fxa-client.min.js.

Development

grunt build - builds the regular and minified version of the library

grunt dev - builds the library, runs jshint, shows library size, runs tests, watches for changes

grunt debug - builds the regular library, runs test, watches for changes. Helpful when you are debugging.

grunt release - will prepare a new release of this library with the version in package.json. It will create or update the repositories in build and docs. If the version in package.json has not changed, then the tagging will be skipped.

SJCL Notes

Currently SJCL is built with ./configure --without-random --without-ocb2 --without-gcm --without-ccm. Adjust this if you need other SJCL features.

Testing

This library uses The Intern testing framework.

npm test - run local tests via Node.js

npm run test-local - run the tests against the local fxa-auth-server

grunt intern:browser - Locally run tests in Selenium (Requires java -jar selenium-server-standalone-2.37.0.jar).

grunt intern:sauce - Run tests on SauceLabs.

Git Commit Guidelines

We loosely follow the Angular commit guidelines of <type>(<scope>): <subject> where type must be one of:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug or adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Documentation

Running grunt doc will create a docs directory, browse the documentation by opening docs/index.html.

Write documentation using YUIDoc Syntax.