Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 3.34 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 3.34 KB
Raw

Contributing

Contributions are always welcome. Before contributing please read the code of conduct and search the issue tracker; your issue may have already been discussed or fixed in main. To contribute, fork this repository, commit your changes, and send a Pull Request.

Note that our code of conduct applies to all platforms and venues related to this project; please follow it in all your interactions with the project and its participants.

Feature Requests

Feature requests should be submitted in the Issue tracker, with a description of the expected behavior & use case, where they’ll remain closed until sufficient interest, e.g. 👍 reactions, has been shown by the community. Before submitting an Issue, please search for similar ones in the closed issues.

Pull Requests

If you’re planning on contributing a new feature or an otherwise complex contribution, we kindly ask you to start a conversation with the maintainer team by opening up a Github issue first.

General Guidelines

This project is licensed under the Apache-2.0 license. Any third party libraries added as dependencies of the project must have a similarly permissive open source license, e.g. MIT.

Coding Style Guidelines/Conventions

All code should follow js-standard-style

We use eslint to enforce our style. To lint your code, you can run npm run lint on the command line. There are plugins available for most editors (see eslint's documentation for more details).

Testing

All changes to the Agent should include test coverage, and each PR must pass all tests against all browsers in SauceLabs locally before being merged.

We run tests on a variety of browsers and platforms to ensure that the agent runs safely for all users. We use Saucelabs, and the test matrix is defined here.

When you first submit your PR, the tests will not be run automatically. After we review the PR, we will add a label that will trigger the full-matrix testing.

See Running Tests for more details on how to run tests locally.

Review

PR Review should look at both code changes, and architectural decisions. A reviewer should ensure that all of the following are true before approving a change:

  • Both the code and the architectural decisions have been thoroughly reviewed and understood by another member of the team.
  • The changes have passed all tests against all browsers in SauceLabs.
  • All code changes in the agent have been covered by new tests.
  • Appropriate documentation changes have been made (where applicable).
  • Extraneous commits have been squashed.
  • Commit message are concise.
  • The change log has been updated (where applicable).