Skip to content

Latest commit

 

History

History
25 lines (15 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

25 lines (15 loc) · 1.12 KB

Contributing

Before contributing to this repository make sure to discuss first the intended changes either on the LWC GUS group or on the lwc slack channel.

Useful commands

Once the repository has been cloned you can run the following commands from the root directory.

$ npm install           # install project dependencies
$ npm run lint          # run linting against project code
$ npm run test     # run test and code coverage

Submitting code

Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.

Review process

The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge. Also make sure to reference the related issues to in the pull request message if any.

Eslint versions

Salesforce currently supports both ESLint v8 and v9. All new rules must be written in both versions. The master branch is on ESLint v9, while ESLint v8 rules are maintained in the eslint-v8 branch.