Consistent file name references
This commit is contained in:
parent
d0da811f3d
commit
c57e58b1ee
|
@ -2,13 +2,13 @@
|
||||||
|
|
||||||
### Checkin
|
### Checkin
|
||||||
|
|
||||||
- Do check in source (src)
|
- Do check in source (`src/`)
|
||||||
- Do check in a single index.js file after running `ncc`
|
- Do check in a single `index.js` file after running `ncc`
|
||||||
- Do not check in node_modules
|
- Do not check in `node_modules/`
|
||||||
|
|
||||||
### NCC
|
### NCC
|
||||||
|
|
||||||
In order to avoid uploading `node_modules` to the repository, we use [zeit/ncc](https://github.com/zeit/ncc) to create a single `index.js` file that gets saved in `dist/`.
|
In order to avoid uploading `node_modules/` to the repository, we use [zeit/ncc](https://github.com/zeit/ncc) to create a single `index.js` file that gets saved in `dist/`.
|
||||||
|
|
||||||
### Developing
|
### Developing
|
||||||
|
|
||||||
|
@ -18,7 +18,7 @@ npm install
|
||||||
tsc
|
tsc
|
||||||
ncc build
|
ncc build
|
||||||
```
|
```
|
||||||
Any files generated using `tsc` will be added to `lib/*`, however those files also are not uploaded to the repository and are exluded using `.gitignore`.
|
Any files generated using `tsc` will be added to `lib/`, however those files also are not uploaded to the repository and are exluded using `.gitignore`.
|
||||||
|
|
||||||
During the commit step, Husky will take care of formatting all files with [Prettier](https://github.com/prettier/prettier)
|
During the commit step, Husky will take care of formatting all files with [Prettier](https://github.com/prettier/prettier)
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue