|
5 | 5 | { |
6 | 6 | "title": "Introduction", |
7 | 7 | "file": "README.md", |
8 | | - "description": "Thank you for your interest in contributing to stdlib, a standard library for JavaScript and Node.js with an emphasis on numerical and scientific computing applications. This tour will guide you through the codebase to help you get started by giving a quick overview of the codebase and pointing to where you can find more information.", |
| 8 | + "description": "Welcome and thank you for your interest in contributing to stdlib, a comprehensive standard library for JavaScript and Node.js designed specifically to meet the demands of numerical and scientific computing. This introductory tour will navigate you through the essentials of our codebase, highlight key components, and direct you to resources to dig deeper.", |
9 | 9 | "line": 516 |
10 | 10 | }, |
11 | 11 | { |
|
15 | 15 | }, |
16 | 16 | { |
17 | 17 | "file": "docs/development.md", |
18 | | - "description": "To setup your development environmet, follow the steps in the `docs/development.md` file or use the VSCode development container.", |
| 18 | + "description": "To setup your development environment, follow the steps in the `docs/development.md` file or use the VSCode development container.", |
19 | 19 | "line": 21 |
20 | 20 | }, |
21 | 21 | { |
22 | 22 | "directory": "docs/style-guides", |
23 | | - "description": "Style guides for source code for the various programming languages used in the project can be found in the `docs/style-guides` folder, including our `git` conventions. We use conventional commits to ensure a consistent commit message format and to automate versioning and changelog generation." |
| 23 | + "description": "Style guides for source code for the various programming languages used in the project is located in the `docs/style-guides` folder, including our `git` conventions. We use conventional commits to ensure a consistent commit message format and to automate versioning and changelog generation." |
24 | 24 | }, |
25 | 25 | { |
26 | 26 | "file": "tools/make/README.md", |
|
37 | 37 | }, |
38 | 38 | { |
39 | 39 | "directory": "lib/node_modules/@stdlib/utils/zip", |
40 | | - "description": "Each package contains at least the following folders:\n\n- `benchmark`: micro-benchmarks for timing the\n- `docs`: contains a `repl.txt` document with help text when the package is used inside the stdlib Node.js REPL and TypeScript definitions and tests in a `types` sub-directory\n- `examples`: example code demonstrating use of the package. This could should match the code inside the `README.md` documentation's \"Examples\" section (with the only possible difference being `console.log` invocations not being included in the `README.md`)\n- `lib`: the package's JavaScript implementation\n- `test`: comphrehensive unit tests, ideally achieving 100% code coverage" |
| 40 | + "description": "Each package contains at least the following folders:\n\n- `benchmark`: micro-benchmarks for timing the\n- `docs`: contains a `repl.txt` document with help text when the package is used inside the stdlib Node.js REPL and TypeScript definitions and tests in a `types` sub-directory\n- `examples`: example code demonstrating use of the package. This could should match the code inside the `README.md` documentation's \"Examples\" section (with the only possible difference being `console.log` invocations not being included in the `README.md`)\n- `lib`: the package's JavaScript implementation\n- `test`: comprehensive unit tests, ideally achieving 100% code coverage" |
41 | 41 | }, |
42 | 42 | { |
43 | 43 | "file": "lib/node_modules/@stdlib/utils/zip/README.md", |
44 | | - "description": "The `README.md` file contains the package documentation. Notice that we use HTML fragments and commnents to demarcate the various sections in the documents, which is used as part of our tooling. The top-level `snippets` directory contains template files that can be used to scaffold out a new package; in practice, we found that often copy-pasting files from a different package with similar API is an efficient workflow.", |
| 44 | + "description": "The `README.md` file contains the package documentation. Notice that we use HTML fragments and comments to demarcate the various sections in the documents, which we use as part of our tooling. The top-level `snippets` directory contains template files that can be used to scaffold out a new package; in practice, we found that often copy-pasting files from a different package with similar API is an efficient workflow.", |
45 | 45 | "line": 33 |
46 | 46 | }, |
47 | 47 | { |
|
54 | 54 | }, |
55 | 55 | { |
56 | 56 | "file": "CONTRIBUTING.md", |
57 | | - "description": "It is our desiree to make contributing to stdlib rewarding and impactful. Please review our guidelines in `CONTRIBUTING.md` to understand our process and expectations. Your contributions help build the numerical computing infrastructure for JavaScript.", |
| 57 | + "description": "It is our desire to make contributing to stdlib rewarding and impactful. Please review our guidelines in `CONTRIBUTING.md` to understand our process and expectations. Your contributions help build the numerical computing infrastructure for JavaScript.", |
58 | 58 | "line": 21 |
59 | 59 | }, |
60 | 60 | { |
|
0 commit comments