From 96ea68a767cd8b4bf2a1c6dbc1cd319c1e8c64fe Mon Sep 17 00:00:00 2001 From: Homa Wong Date: Sat, 11 Jun 2022 00:29:45 -0700 Subject: [PATCH] docs: misc update --- CONTRIBUTING.md | 8 ++++---- REFERENCES.md | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d916e2b0c..3e5cebad9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,11 @@ -# Contributer's Guide +# Contributor's Guide -We welcome contributions from the community and have gathered guidelines +We welcome contributions from the community and have gathered guidelines here to help you get started. ## Discussion -While not absolutely required, it is encouraged that you first open an issue +While not absolutely required, it is encouraged that you first open an issue for any bug or feature request. This allows discussion on the proper course of action to take before coding begins. @@ -69,7 +69,7 @@ To investigate slowdowns in build times, it's often helpful to profile webpack & 1. Start webpack with a debugger attached (see debugging steps above) 2. Identify the reproducible user scenario that is experiencing slowdowns 3. In Chrome, open `chrome://inspect` and inspect the running webpack instance - 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. + 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. 4. Switch to the Profiling Tab 5. Start Recording 6. Kick off the scenario that's known to be slow diff --git a/REFERENCES.md b/REFERENCES.md index 93501de67..67a4e9f77 100644 --- a/REFERENCES.md +++ b/REFERENCES.md @@ -34,7 +34,7 @@ There are a few points to note: 1. You need to use tsc --build to compile the project. 1. When you compile the project tsc --build 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. 1. There is no need to use the incremental compiler option. tsc --build will generate and use tsconfig.tsbuildinfo anyway. -1. If you delete your compiled code and re-run tsc --build the code will **not **be rebuilt unless you also delete the tsconfig.tsbuildinfo file. Use the tsc --build --clean command to do this for you. +1. If you delete your compiled code and re-run tsc --build the code will **not** be rebuilt unless you also delete the tsconfig.tsbuildinfo file. Use the tsc --build --clean command to do this for you. 1. If you set the declaration and declarationMap settings in tsconfig.json the outDir folder will contain .d.ts and .d.ts.map files alongside the transpiled JavaScript. When you consume the compiled project you should consume the outDir folder, not the src. Even though your root project is in TypeScript it can use full syntax checking without the subproject’s TypeScript source because the outDir folder contains the definitions in the .d.ts 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. @@ -154,7 +154,7 @@ Now TypeScript understands that when it sees packages/reference1 in Unless you are using tsconfig-paths-webpack-plugin you may need to include a corresponding resolve-alias setting in your webpack.config.js: ``` const path = require('path'); - + module.exports = { modules: [ "node_modules",