Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 829 Bytes

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 829 Bytes

Contributing

Adding and upgrading plugins

When adding or upgrading a plugin, we should see changes in both package.json and yarn.lock.

Make sure to run make image before running these commands.

Add a plugin:

bin/yarn add eslint-config-google

Upgrade a plugin:

bin/yarn upgrade eslint-config-google

Testing Changes

Changes made to the engine can be tested locally.

  1. Install the CodeClimate CLI.

  2. Create the image (customizing the IMAGE_NAME as needed):

    IMAGE_NAME=codeclimate/codeclimate-eslint-test make image
  3. Add the engine to your test .codeclimate.yml:

    engines:
      eslint-test:
        enabled: true
  4. Run analyze via the CLI:

    codeclimate analyze --dev