empathy for those new to typescript projects
This commit is contained in:
parent
4976c1864c
commit
b21b43df68
1 changed files with 18 additions and 0 deletions
18
CONTRIBUTING.md
Normal file
18
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
## bootstrapping
|
||||||
|
|
||||||
|
This a [JavaScript](https://help.github.com/en/articles/about-actions#types-of-actions) action but uses [TypeScript](https://www.typescriptlang.org/docs/home.html) to generate that JavaScript.
|
||||||
|
|
||||||
|
You can bootstrap your envrinment with a modern version of npm and by running `npm i` at the root of this repo.
|
||||||
|
|
||||||
|
## testing
|
||||||
|
|
||||||
|
Tests can be found under under `__tests__` directory and are runnable with the `npm t` command
|
||||||
|
|
||||||
|
## source code
|
||||||
|
|
||||||
|
Source code can be found under the `src` directory. Running `npm run build` will generate the JavaScript that will run within GitHub workflows.
|
||||||
|
|
||||||
|
## formatting
|
||||||
|
|
||||||
|
A minimal attempt at keeping a consistent code style is can be applied by running `npm run fmt`
|
||||||
|
|
Loading…
Reference in a new issue