You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributors.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,29 +2,29 @@
2
2
3
3
### Checkin
4
4
5
-
- Do checkin source (src)
6
-
- Do checkin a single index.js file after running `ncc`
7
-
- Do not checkin node_modules
5
+
- Do check in source (`src/`)
6
+
- Do check in a single `index.js` file after running `ncc`
7
+
- Do not check in `node_modules/`
8
8
9
9
### NCC
10
10
11
-
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/`.
11
+
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/`.
12
12
13
13
### Developing
14
14
15
-
If you're developing locally you can run
15
+
If you're developing locally, you can run
16
16
```
17
17
npm install
18
18
tsc
19
19
ncc build
20
20
```
21
-
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`.
21
+
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`.
22
22
23
23
During the commit step, Husky will take care of formatting all files with [Prettier](https://github.com/prettier/prettier)
24
24
25
25
### Testing
26
26
27
-
We ask that you include a link to a succesfull run that utilizes the changes you are working on. For example, if your changes are in the branch `newAwesomeFeature`, then show an example run that uses `setup-python@newAwesomeFeature` or `my-fork@newAwesomeFeature`. This will help speed up testing and help us confirm that there are no breaking changes or bugs.
27
+
We ask that you include a link to a successful run that utilizes the changes you are working on. For example, if your changes are in the branch `newAwesomeFeature`, then show an example run that uses `setup-python@newAwesomeFeature` or `my-fork@newAwesomeFeature`. This will help speed up testing and help us confirm that there are no breaking changes or bugs.
0 commit comments