Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

32 lines (19 loc) · 1.82 KB
Raw

Contributing

Reporting bugs

Report any bugs in the GitHub Issue Tracker.

Attach your tsconfig.json, package.json (for versions of dependencies), rollup.config.js, and anything else that could influence module resolution, ambient types, and TS compilation.

Check if the problem is reproducible after running npm prune to clear any rogue types from node_modules (by default TS grabs all ambient types).

Check if you get the same problem with clean option set to true (might indicate a bug in the cache).

If it makes sense, check if running tsc directly produces similar results.

Attach plugin output with verbosity option set to 3 (this will list all files being transpiled and their imports).

Developing

Use the standard GitHub process of forking, making a branch, and creating a PR when ready. Fix all linting problems (npm run lint) and fix any failed checks on the PR. Use an editor that supports editorconfig, or match the settings from .editorconfig manually.

Fastest way to test changes is to do a self build; the plugin is part of its own build system:

  1. make changes
  2. run npm build (uses last released version on npm)
  3. check that you get expected changes in dist
  4. run npm build-self (uses fresh local build)
  5. check dist for the expected changes
  6. run npm build-self again to make sure plugin built by new version can still build itself

If build-self breaks at some point, fix the problem and restart from the build step (a known good copy).

This repo badly needs unit tests and integration tests with various scenarios and expected outcomes though.