Skip to content

Commit d954b03

Browse files
authored
docs: misc update (#1475)
1 parent 8e389d9 commit d954b03

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Contributer's Guide
1+
# Contributor's Guide
22

3-
We welcome contributions from the community and have gathered guidelines
3+
We welcome contributions from the community and have gathered guidelines
44
here to help you get started.
55

66
## Discussion
77

8-
While not absolutely required, it is encouraged that you first open an issue
8+
While not absolutely required, it is encouraged that you first open an issue
99
for any bug or feature request. This allows discussion on the proper course of
1010
action to take before coding begins.
1111

@@ -69,7 +69,7 @@ To investigate slowdowns in build times, it's often helpful to profile webpack &
6969
1. Start webpack with a debugger attached (see debugging steps above)
7070
2. Identify the reproducible user scenario that is experiencing slowdowns
7171
3. In Chrome, open `chrome://inspect` and inspect the running webpack instance
72-
Note: Utilizing Chromium instead of Chrome sometimes yeilds better results. If any of the following steps fail or cause a crash, try switching from Chrome to Chromium.
72+
Note: Utilizing Chromium instead of Chrome sometimes yields better results. If any of the following steps fail or cause a crash, try switching from Chrome to Chromium.
7373
4. Switch to the Profiling Tab
7474
5. Start Recording
7575
6. Kick off the scenario that's known to be slow

REFERENCES.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ There are a few points to note:
3434
1. You need to use <code>tsc --build</code> to compile the project.
3535
1. When you compile the project <code>tsc --build</code> will create a file called tsconfig.tsbuildinfo that contains the signatures and timestamps of all files required to build the project. On subsequent builds TypeScript will use that information to detect the least costly way to type-check and emit changes to your project.
3636
1. There is no need to use the incremental compiler option. <code>tsc --build</code> will generate and use tsconfig.tsbuildinfo anyway.
37-
1. If you delete your compiled code and re-run <code>tsc --build</code> the code will **not **be rebuilt unless you also delete the <code>tsconfig.tsbuildinfo</code> file. Use the <code>tsc --build --clean</code> command to do this for you.
37+
1. If you delete your compiled code and re-run <code>tsc --build</code> the code will **not** be rebuilt unless you also delete the <code>tsconfig.tsbuildinfo</code> file. Use the <code>tsc --build --clean</code> command to do this for you.
3838

3939
1. If you set the <code>declaration</code> and <code>declarationMap</code> settings in <code>tsconfig.json</code> the <code>outDir</code> folder will contain <code>.d.ts</code> and <code>.d.ts.map</code> files alongside the transpiled JavaScript. When you consume the compiled project you should consume the <code>outDir</code> folder, not the <code>src</code>. Even though your root project is in TypeScript it can use full syntax checking without the subproject’s TypeScript source because the <code>outDir</code> folder contains the definitions in the <code>.d.ts</code> file. Vscode (and many other code editors and IDEs) will be able to find the definitions and perform syntax checking in the editor just as if you were not using project references and importing the TypeScript source directly.
4040

@@ -154,7 +154,7 @@ Now TypeScript understands that when it sees <code>packages/reference1</code> in
154154
Unless you are using tsconfig-paths-webpack-plugin you may need to include a corresponding resolve-alias setting in your <code>webpack.config.js</code>:
155155
```
156156
const path = require('path');
157-
157+
158158
module.exports = {
159159
modules: [
160160
"node_modules",

0 commit comments

Comments
 (0)