Skip to content

Commit 7d6dd46

Browse files
authored
Contributing section in readme
1 parent eef600d commit 7d6dd46

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,3 +199,19 @@ Check if you get the same problem with `clean` option set to true (might indicat
199199
If makes sense, check if running `tsc` directly produces similar results.
200200

201201
Attach plugin output with `verbosity` option set to 3 (this will list all files being transpiled and their imports).
202+
203+
### Contributing
204+
205+
Use the normal github process of forking, making a branch and creating a PR when ready. Fix all linting problems (run `npm lint`), fix any failed checks that are run on the PR (basically lint right now). Use an editor that supports editorconfig, or match the settings from `.editorconfig` file manually.
206+
207+
Fastest way to test changes is to do a self build, the plugin is part of its own build system:
208+
- make changes
209+
- run `npm build` (uses build committed to master branch)
210+
- check that you get expected changes in `dist`
211+
- run `npm build-self` (uses fresh local build)
212+
- check `dist` for the expected changes
213+
- run `npm build-self` _again_ to make sure plugin built by new version can still build itself
214+
215+
If `build-self` breaks at some point, fix the problem and restart from `build` step (a known good copy).
216+
217+
This repo badly needs unittests though.

0 commit comments

Comments
 (0)