mozilla
/
fxa-content-server
зеркало из https://github.com/mozilla/fxa-content-server.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
fxa-content-server/CONTRIBUTING.md

5.9 KiB
Исходник Ответственный История

Contribution Guidelines for the Firefox Accounts Content Server

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 reviewed.
    • Run grunt lint 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 lint 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.
  • Your commit message must follow the commit guidelines.

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.

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

Scope

The scope could be anything specifying place of the commit change. For example oauth, fxa-client, signup, l10n etc...

Subject

The subject contains succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize first letter
  • no dot (.) at the end

Body

In order to maintain a reference to the context of the commit, add fixes #<issue_number> if it closes a related issue or issue #<issue_number> if it's a partial fix.

You can also write a detailed description of the commit: Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes" It should include the motivation for the change and contrast this with previous behavior.

###Footer The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.

Grunt Commands

Grunt is used to run common tasks to build, test, and run local servers.

Task Description
grunt lint run ESLint, Sass-lint, amdcheck and JSONLint on client side and testing JavaScript.
grunt build build production resources.
grunt clean remove any built production resources.
grunt test run local Intern tests.
grunt server run a local server running on port 3030 with development resources.
grunt server:dist run a local server running on port 3030 with production resources. Production resources will be built as part of the task.
grunt version stamp a new version. Updates the version number and creates a new CHANGELOG.md file.

Test Options

Command Description
npm test Run unit and functional tests locally.
npm run test-functional Run functional tests locally.
npm run test-functional-oauth Run OAuth functional tests locally.
npm run test-sauce Run functional tests on Sauce Labs. Requires credentials.
npm run test-server Run server tests.
npm run test-latest Run full functional tests (OAuth, Firefox Sync UI) against http://latest.dev.lcip.org.

Servers

Dependencies and Tools

Bower

We use Bower to manage front-end packages. These components are automatically installed when you install this project and are placed into the app directory.

L10N

To contribute translations visit mozilla/fxa-content-server-l10n. Use the FXA_L10N_SHA to pin L10N files to certain Git SHA. If not set then the master branch SHA will be used.

License

MPL 2.0