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/development/accessibility.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,7 +59,7 @@ Developers may also use pre-made components with accessibility features built in
59
59
60
60
Users should make sure to read and understand the accessibility documentation for pre-made components.
61
61
It is also best practice to incorporate testing of your application with common
62
-
assisitive technologies like screen readers and limiting input to keyboard interaction. See [tooling](#tooling) below.
62
+
assistive technologies like screen readers and limiting input to keyboard interaction. See [tooling](#tooling) below.
63
63
64
64
For those working on Linux
65
65
[List Of Accessibility Documentation Sources And Tools (For GNU/Linux Development And Testing)](https://desktopqe-jenkins.rhev-ci-vms.eng.rdu2.redhat.com:3200/desktopqe/d06-projects/a11y.A11y_devel_doc_sources.html)
@@ -76,7 +76,7 @@ reference for working with the guidelines. The [WAI-ARIA Authoring Practices Exa
76
76
77
77
In the teams experience testing/validation of accessibility requirements will be
78
78
against the front-end and not the APIs provided by the Node.js back-end. The result
79
-
being that team members building the front-end must be knowleadgeable on
79
+
being that team members building the front-end must be knowledgeable on
80
80
accessibility requirements. Back-end Node.js developers, on the other hand, will support
81
81
requirements that come from the front-end versus driving the accessibility effort.
82
82
@@ -104,7 +104,7 @@ accessibility testing.
104
104
Command line tools have been historically considered more accessible (see
105
105
[Accessibility of Command Line Interfaces](https://dl.acm.org/doi/fullHtml/10.1145/3411764.3445544)
106
106
for discussion on this topic).
107
-
For this reason, most if not all of accessibility standards and guidlines are for
107
+
For this reason, most if not all of accessibility standards and guidelines are for
108
108
graphical user interfaces. The team is not aware of standards or guidelines that
109
109
provide guidance specifically for command line applications.
110
110
@@ -128,7 +128,7 @@ include:
128
128
129
129
Accessibility tooling is generally not Node.js specific. However some tools are
130
130
built in Node.js and are delivered through npm. They will, therefore, fit easily in a JavaScript
Copy file name to clipboardExpand all lines: docs/development/cross-origin.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ There are two patterns that the team is familiar with when dealing with Cross Or
7
7
8
8
## Cross Origin Resource Sharing (CORS)
9
9
10
-
By default, browers assume that your backend server doesn't want to share its resources with a front-end that it doesn't know about.
10
+
By default, browsers assume that your backend server doesn't want to share its resources with a front-end that it doesn't know about.
11
11
12
12
You might have seen this error in the browsers dev console:
13
13
@@ -21,7 +21,7 @@ However, there are certain situations where your backend might want to be access
21
21
22
22
When developing a backend with a public API and you would like to control access to certain resources and how they are used, CORS should be enabled.
23
23
24
-
**note: When enabling CORS, it is important to limit those methods and headers your application allows to prevent unwanted actors from accessesing resources they shouldn't be accessing.**
24
+
**note: When enabling CORS, it is important to limit those methods and headers your application allows to prevent unwanted actors from accessing resources they shouldn't be accessing.**
Copy file name to clipboardExpand all lines: docs/development/mono-repository.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,7 +65,7 @@ While there are a benefits, there are challenges to overcome.
65
65
* Detecting what to build. Build times can be long due to overbuilding the entire repository
66
66
* Long build times. Because of having to build the entire repository, this will cause build times to increase because tooling no longer is just building one artifact/package, but many different ones.
67
67
* Not just JavaScript. A monorepo may not just be JavaScript, and can impact organization, tooling, and how to approach building different artifacts or packages in different languages.
68
-
* Git repositories can grow larger in size. Since we are building and maintaing different packages in a singular repository, we can exponentially grow the size of the git repository.
68
+
* Git repositories can grow larger in size. Since we are building and maintaining different packages in a singular repository, we can exponentially grow the size of the git repository.
69
69
* Commit messages can be harder to interpret due to multiple artifacts, packages, or teams.
Copy file name to clipboardExpand all lines: docs/development/npm-package-development.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -89,9 +89,9 @@ to the public npm registry
89
89
90
90
***private** - This field is only recommended and should be set to `yes` if your package will not be published to npm.
91
91
92
-
***support** - This field is to help package maintainers communicate with and set expectations for their users about the level of support they are willing to provide on a package. The team has worked closely with the [Node.js Package Maintence Team](https://github.com/nodejs/package-maintenance) on their recommendations on what this support field should look like. For one of your modules, [opossum](https://github.com/nodeshift/opossum), we [set this field](https://github.com/nodeshift/opossum/blob/main/package.json#L75) to `true` and supplied our support information in a separate [package-support.json file](https://github.com/nodeshift/opossum/blob/main/package-support.json).
92
+
***support** - This field is to help package maintainers communicate with and set expectations for their users about the level of support they are willing to provide on a package. The team has worked closely with the [Node.js Package Maintenance Team](https://github.com/nodejs/package-maintenance) on their recommendations on what this support field should look like. For one of your modules, [opossum](https://github.com/nodeshift/opossum), we [set this field](https://github.com/nodeshift/opossum/blob/main/package.json#L75) to `true` and supplied our support information in a separate [package-support.json file](https://github.com/nodeshift/opossum/blob/main/package-support.json).
93
93
94
-
For more information on the support field, check out what the [Package Maintence Team says](https://github.com/nodejs/package-maintenance/blob/main/docs/PACKAGE-SUPPORT.md)
94
+
For more information on the support field, check out what the [Package Maintenance Team says](https://github.com/nodejs/package-maintenance/blob/main/docs/PACKAGE-SUPPORT.md)
95
95
96
96
***type** - This field defines the module format that Node.js will use. For ES Modules(ESM), use `module` and for Common JS(CJS) modules, use `commonjs`. For more information on how Node.js determines the difference between ESM and CJS modules take a [look at the Node.js official docs here](https://nodejs.org/dist/latest-v18.x/docs/api/packages.html#determining-module-system)
97
97
@@ -105,9 +105,9 @@ While there is no list of development dependencies that the team recommends, we
105
105
106
106
For the teams guidance on choosing dependencies, check out the [Choosing and vetting dependencies](./dependencies.md).
107
107
108
-
During development of a pacakge, it is helpful to add the package-lock.json to source control, so all developers working on the package will be able to install the same versions of dependencies.
108
+
During development of a package, it is helpful to add the package-lock.json to source control, so all developers working on the package will be able to install the same versions of dependencies.
109
109
110
-
It is also recommended to know what semver range you are specifying for any dependecy you wish to install. For example:
110
+
It is also recommended to know what semver range you are specifying for any dependency you wish to install. For example:
111
111
112
112
The `^` will give you all the minor and patch releases when they become available.
113
113
@@ -123,7 +123,7 @@ npm Workspaces supports managing multiple projects within a singular top-level,
123
123
124
124
### Bundlers and Transpilers
125
125
126
-
Bundlers are helpful if your package needs to be used by both Node.js and the browser. The same codebase can be packaged for multiple platforms with a trivial amount of work by using a bundler. [Webpack](https://webpack.js.org/) is one such bundler that the team has some familarity with.
126
+
Bundlers are helpful if your package needs to be used by both Node.js and the browser. The same codebase can be packaged for multiple platforms with a trivial amount of work by using a bundler. [Webpack](https://webpack.js.org/) is one such bundler that the team has some familiarity with.
127
127
128
128
For those packages being written in Typescript, you will need to use a transpiler since Node.js does not support running TypeScript natively, so it must first be transpiled to JavaScript. We recommend the `tsc` transpiler that is shipped with [typescript](https://www.npmjs.com/package/typescript). This supports both type checking and transpilation to JavaScript.
0 commit comments