Skip to content

Commit 9562983

Browse files
authored
fix: Remaining auto-fixable remark-lint rules (#1002)
1 parent 232899c commit 9562983

File tree

107 files changed

+585
-401
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

107 files changed

+585
-401
lines changed

.remarkrc

+1-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@
22
"plugins": [
33
"remark-gfm",
44
"remark-preset-lint-node",
5-
["remark-lint-fenced-code-flag", false],
6-
["remark-lint-first-heading-level", false],
75
["remark-lint-maximum-line-length", false],
8-
["remark-lint-prohibited-strings", false],
9-
["remark-lint-unordered-list-marker-style", false]
6+
["remark-lint-prohibited-strings", false]
107
]
118
}

OpenSSL-Strategy.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ This policy document describes for each release line:
55
* Which versions of OpenSSL Node.js will include.
66
* Which versions of a "shared" OpenSSL Node.js will support.
77
* What version of TLS will be supported
8-
- by default,
9-
- with run-time configuration.
8+
* by default,
9+
* with run-time configuration.
1010
* Whether FIPS will be supported.
1111

1212
It also gives background on OpenSSL release lifetimes, TLS1.3, and FIPS support,
@@ -39,13 +39,15 @@ OpenSSL LTS support timing, the lack of OpenSSL LTS planning and the lack of a
3939
clear timeframe for a new FIPS module complicates Node.js 10.
4040

4141
For Node.js < 10.16.0:
42+
4243
* OpenSSL version: 1.1.0
4344
* Allowed shared OpenSSL version: 1.1.0
4445
* Default minimum TLS version is TLSv1, default maximum is TLSv1.2. No other
4546
TLS versions are supported by this version of OpenSSL or Node.js.
4647
* FIPS: not supported
4748

4849
For Node.js >= 10.16.0:
50+
4951
* OpenSSL version: 1.1.1
5052
* Allowed shared OpenSSL version: 1.1.0 or 1.1.1
5153
* Default minimum TLS version is TLSv1, default maximum is TLSv1.2. It is
@@ -88,13 +90,15 @@ This release will not be designated LTS. It was updated to include OpenSSL 1.1.1
8890
in [11.9.0](https://nodejs.org/en/blog/release/v11.9.0/).
8991

9092
For Node.js < 11.9.0:
93+
9194
* OpenSSL version: 1.1.0
9295
* Allowed shared OpenSSL version: 1.1.0
9396
* Default minimum TLS version is TLSv1, default maximum is TLSv1.2. No other
9497
TLS versions are supported by this version of OpenSSL or Node.js.
9598
* FIPS: not supported
9699

97100
For Node.js >= 11.9.0:
101+
98102
* OpenSSL version: 1.1.0
99103
* Allowed shared OpenSSL version: 1.1.0 or 1.1.1
100104
* Default minimum TLS version is TLSv1, default maximum is TLSv1.2. It is
@@ -112,9 +116,10 @@ For Node.js >= 11.9.0:
112116
* FIPS: not supported
113117

114118
Node.js EOL dates:
115-
- 12.x: April 2022
116-
- 13.x: June, 2020
117-
- 14.x: April 2023
119+
120+
* 12.x: April 2022
121+
* 13.x: June, 2020
122+
* 14.x: April 2023
118123

119124
## Node.js version 15.x (est. Oct 2020) (EOL Jun 2021)
120125

@@ -150,6 +155,7 @@ For minimal disruption, it would probably be helpful if Node.js supported
150155
building against OpenSSL 1.1.1 out-of-tree, even if OpenSSL 3.x was in-tree.
151156

152157
Challenges are:
158+
153159
1. OpenSSL 3.x moved many algorithms into a legacy library, that is only
154160
accessible as a dynamically loaded provider, so cannot ship with Node.js
155161
2. Node.js has a build system wrapped around OpenSSL 1.1.1, it is currently

Security-Team.md

+67-66
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,16 @@ includes a fix, documentation, an informational CVE or blog post.
3535

3636
<!-- ncu-team-sync.team(nodejs/security-triage) -->
3737

38-
- [@bnoordhuis](https://github.com/bnoordhuis) - Ben Noordhuis
39-
- [@cjihrig](https://github.com/cjihrig) - Colin Ihrig
40-
- [@indutny](https://github.com/indutny) - Fedor Indutny
41-
- [@jasnell](https://github.com/jasnell) - James M Snell
42-
- [@mcollina](https://github.com/mcollina) - Matteo Collina
43-
- [@MylesBorins](https://github.com/MylesBorins) - Myles Borins
44-
- [@ronag](https://github.com/ronag) - Robert Nagy
45-
- [@shigeki](https://github.com/shigeki) - Shigeki Ohtsu
46-
- [@vdeturckheim](https://github.com/vdeturckheim) - Vladimir de Turckheim
47-
- [@watson](https://github.com/watson) - Thomas Watson
38+
* [@bnoordhuis](https://github.com/bnoordhuis) - Ben Noordhuis
39+
* [@cjihrig](https://github.com/cjihrig) - Colin Ihrig
40+
* [@indutny](https://github.com/indutny) - Fedor Indutny
41+
* [@jasnell](https://github.com/jasnell) - James M Snell
42+
* [@mcollina](https://github.com/mcollina) - Matteo Collina
43+
* [@MylesBorins](https://github.com/MylesBorins) - Myles Borins
44+
* [@ronag](https://github.com/ronag) - Robert Nagy
45+
* [@shigeki](https://github.com/shigeki) - Shigeki Ohtsu
46+
* [@vdeturckheim](https://github.com/vdeturckheim) - Vladimir de Turckheim
47+
* [@watson](https://github.com/watson) - Thomas Watson
4848

4949
<!-- ncu-team-sync end -->
5050

@@ -54,12 +54,13 @@ The [TSC](https://github.com/nodejs/node#tsc-technical-steering-committee)
5454
have access.
5555

5656
These non-TSC and TSC Emeriti also have access:
57+
5758
* [bnoordhuis](https://github.com/bnoordhuis) - **Ben Noordhuis**
5859
* [indutny](https://github.com/indutny) - **Fedor Indutny**
5960
* [ronag](https://github.com/ronag) - **Robert Nagy**
6061
* [rvagg](https://github.com/rvagg) - **Rod Vagg**
6162
* [vdeturckheim](https://github.com/vdeturckheim) - **Vladimir de Turckheim**
62-
- [@watson](https://github.com/watson) - **Thomas Watson**
63+
* [@watson](https://github.com/watson) - **Thomas Watson**
6364

6465
List is from the [member page](https://hackerone.com/nodejs/team_members) for
6566
the Node.js program on HackerOne.
@@ -68,39 +69,39 @@ the Node.js program on HackerOne.
6869

6970
<!-- ncu-team-sync.team(nodejs-private/security) -->
7071

71-
- [@apapirovski](https://github.com/apapirovski) - Anatoli Papirovski
72-
- [@BethGriggs](https://github.com/BethGriggs) - Bethany Nicolle Griggs
73-
- [@bnoordhuis](https://github.com/bnoordhuis) - Ben Noordhuis
74-
- [@BridgeAR](https://github.com/BridgeAR) - Ruben Bridgewater
75-
- [@ChALkeR](https://github.com/ChALkeR) - Сковорода Никита Андреевич
76-
- [@cjihrig](https://github.com/cjihrig) - Colin Ihrig
77-
- [@codebytere](https://github.com/codebytere) - Shelley Vohr
78-
- [@danbev](https://github.com/danbev) - Daniel Bevenius
79-
- [@dougwilson](https://github.com/dougwilson) - Douglas Wilson
80-
- [@evilpacket](https://github.com/evilpacket) - Adam Baldwin
81-
- [@fhinkel](https://github.com/fhinkel) - F. Hinkelmann
82-
- [@gabrielschulhof](https://github.com/gabrielschulhof) - Gabriel Schulhof
83-
- [@gireeshpunathil](https://github.com/gireeshpunathil) - Gireesh Punathil
84-
- [@indutny](https://github.com/indutny) - Fedor Indutny
85-
- [@jasnell](https://github.com/jasnell) - James M Snell
86-
- [@jbergstroem](https://github.com/jbergstroem) - Johan Bergström
87-
- [@joaocgreis](https://github.com/joaocgreis) - João Reis
88-
- [@joyeecheung](https://github.com/joyeecheung) - Joyee Cheung
89-
- [@mcollina](https://github.com/mcollina) - Matteo Collina
90-
- [@mhdawson](https://github.com/mhdawson) - Michael Dawson
91-
- [@mmarchini](https://github.com/mmarchini) - mary marchini
92-
- [@MylesBorins](https://github.com/MylesBorins) - Myles Borins
93-
- [@richardlau](https://github.com/richardlau) - Richard Lau
94-
- [@ronag](https://github.com/ronag) - Robert Nagy
95-
- [@ruyadorno](https://github.com/ruyadorno) - Ruy Adorno
96-
- [@rvagg](https://github.com/rvagg) - Rod Vagg
97-
- [@saghul](https://github.com/saghul) - Saúl Ibarra Corretgé
98-
- [@shigeki](https://github.com/shigeki) - Shigeki Ohtsu
99-
- [@targos](https://github.com/targos) - Michaël Zasso
100-
- [@tniessen](https://github.com/tniessen) - Tobias Nießen
101-
- [@Trott](https://github.com/Trott) - Rich Trott
102-
- [@vdeturckheim](https://github.com/vdeturckheim) - Vladimir de Turckheim
103-
- [@watson](https://github.com/watson) - Thomas Watson
72+
* [@apapirovski](https://github.com/apapirovski) - Anatoli Papirovski
73+
* [@BethGriggs](https://github.com/BethGriggs) - Bethany Nicolle Griggs
74+
* [@bnoordhuis](https://github.com/bnoordhuis) - Ben Noordhuis
75+
* [@BridgeAR](https://github.com/BridgeAR) - Ruben Bridgewater
76+
* [@ChALkeR](https://github.com/ChALkeR) - Сковорода Никита Андреевич
77+
* [@cjihrig](https://github.com/cjihrig) - Colin Ihrig
78+
* [@codebytere](https://github.com/codebytere) - Shelley Vohr
79+
* [@danbev](https://github.com/danbev) - Daniel Bevenius
80+
* [@dougwilson](https://github.com/dougwilson) - Douglas Wilson
81+
* [@evilpacket](https://github.com/evilpacket) - Adam Baldwin
82+
* [@fhinkel](https://github.com/fhinkel) - F. Hinkelmann
83+
* [@gabrielschulhof](https://github.com/gabrielschulhof) - Gabriel Schulhof
84+
* [@gireeshpunathil](https://github.com/gireeshpunathil) - Gireesh Punathil
85+
* [@indutny](https://github.com/indutny) - Fedor Indutny
86+
* [@jasnell](https://github.com/jasnell) - James M Snell
87+
* [@jbergstroem](https://github.com/jbergstroem) - Johan Bergström
88+
* [@joaocgreis](https://github.com/joaocgreis) - João Reis
89+
* [@joyeecheung](https://github.com/joyeecheung) - Joyee Cheung
90+
* [@mcollina](https://github.com/mcollina) - Matteo Collina
91+
* [@mhdawson](https://github.com/mhdawson) - Michael Dawson
92+
* [@mmarchini](https://github.com/mmarchini) - mary marchini
93+
* [@MylesBorins](https://github.com/MylesBorins) - Myles Borins
94+
* [@richardlau](https://github.com/richardlau) - Richard Lau
95+
* [@ronag](https://github.com/ronag) - Robert Nagy
96+
* [@ruyadorno](https://github.com/ruyadorno) - Ruy Adorno
97+
* [@rvagg](https://github.com/rvagg) - Rod Vagg
98+
* [@saghul](https://github.com/saghul) - Saúl Ibarra Corretgé
99+
* [@shigeki](https://github.com/shigeki) - Shigeki Ohtsu
100+
* [@targos](https://github.com/targos) - Michaël Zasso
101+
* [@tniessen](https://github.com/tniessen) - Tobias Nießen
102+
* [@Trott](https://github.com/Trott) - Rich Trott
103+
* [@vdeturckheim](https://github.com/vdeturckheim) - Vladimir de Turckheim
104+
* [@watson](https://github.com/watson) - Thomas Watson
104105

105106
<!-- ncu-team-sync end -->
106107

@@ -113,9 +114,9 @@ Report states are described in HackerOne [docs](https://docs.hackerone.com/progr
113114
The expected workflow for issues reported to Node.js is:
114115

115116
1. `NEW`: issue reported (initial state). Issues in this state are in the
116-
process of being analyzed with the intention to move them into either
117-
`TRIAGED`, `NEEDS-MORE-INFO`, or one of the "Closed" states
118-
(`NOT-APPLICABLE`, `INFORMATIVE`, etc.). Has several sub-states:
117+
process of being analyzed with the intention to move them into either
118+
`TRIAGED`, `NEEDS-MORE-INFO`, or one of the "Closed" states
119+
(`NOT-APPLICABLE`, `INFORMATIVE`, etc.). Has several sub-states:
119120
1. `H1 Triage`: Issues start off assigned to the `H1 Triage` team. That team
120121
does initial triage. They ask for a runnable reproduction, they run it,
121122
and they verify whether it does in fact appear to demonstrate a
@@ -129,36 +130,36 @@ The expected workflow for issues reported to Node.js is:
129130
When further progress on the issue is blocked on response from the reporter,
130131
this is the state.
131132
2. `TRIAGED`: State for an issue when it is a non-duplicate and resolvable.
132-
Issues in this state are waiting for the Node.js team to take some action to
133-
resolve them. Typically, this would be publishing a Node.js release that
134-
resolves the issue, but it could also be publishing documentation, or making
135-
a configuration change to our infrastructure for a <https://nodejs.org>
136-
problem. The expected resolution should be described in a comment on the
137-
issue when it is moved to `TRIAGED`.
138-
- ...: There are no explicit states for an issue as it is in process of
133+
Issues in this state are waiting for the Node.js team to take some action to
134+
resolve them. Typically, this would be publishing a Node.js release that
135+
resolves the issue, but it could also be publishing documentation, or making
136+
a configuration change to our infrastructure for a <https://nodejs.org>
137+
problem. The expected resolution should be described in a comment on the
138+
issue when it is moved to `TRIAGED`.
139+
* ...: There are no explicit states for an issue as it is in process of
139140
getting resolved. Comments on the issue when someone is working on it are
140141
useful, as is assignment of the issue to a person who agrees to be
141142
responsible for following it through to resolution and disclosure.
142-
- Once a fix is ready for release, the issue should be assigned to the
143+
* Once a fix is ready for release, the issue should be assigned to the
143144
`Ready for release` team, and a comment added indicating the relevant PRs that
144145
need to be merged during the release process.
145-
5. `RESOLVED`: State for an issue that has had a fix published. Issues in this
146-
state should be disclosed.
147-
6. ...: Final states for issues that we will not fix:
148-
- `NOT-APPLICABLE`: We do not agree this a vulnerability. We can request
146+
3. `RESOLVED`: State for an issue that has had a fix published. Issues in this
147+
state should be disclosed.
148+
4. ...: Final states for issues that we will not fix:
149+
* `NOT-APPLICABLE`: We do not agree this a vulnerability. We can request
149150
that the reporter close it to preserve their H1 "reputation points". If
150151
it is an issue, though not a vulnerability, we can suggest that it be
151152
reported to the Node.js issue tracker.
152-
- `INFORMATIVE`: This means we agree that the report contains useful
153+
* `INFORMATIVE`: This means we agree that the report contains useful
153154
information, but we don't intend to publish a fix. This might be because
154155
it isn't possible, or because its in an unsupported API or version. We
155156
can consider disclosing it if we think the information should be
156157
publicized.
157-
- `DUPLICATE`: The report is a duplicate of an already reported issue. It
158+
* `DUPLICATE`: The report is a duplicate of an already reported issue. It
158159
should not need disclosure, because the original issue will be disclosed
159160
after it is resolved.
160-
- `SPAM`: Self-explanatory (and rare).
161-
7. Disclosure: This not a HackerOne report state, but it is the final state
162-
from our perspective. Disclosure should be considered once an issue is
163-
closed. See the
164-
[disclosure docs](https://docs.hackerone.com/programs/disclosure.html).
161+
* `SPAM`: Self-explanatory (and rare).
162+
5. Disclosure: This not a HackerOne report state, but it is the final state
163+
from our perspective. Disclosure should be considered once an issue is
164+
closed. See the
165+
[disclosure docs](https://docs.hackerone.com/programs/disclosure.html).

Streaming/Streaming-To-Youtube.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Your YouTube Account must be a manager of the
1313
Ask the TSC Chair or foundation managers (Amanda Ennis, Brian Warner, Rachel
1414
Romoff) to make your account a manager. To add managers or verify an account
1515
is a manager:
16+
1617
1. Go to <https://youtube.com>
1718
2. Click on the node.js icon on the right top.
1819
3. Select settings, select "Add or remove managers", select "Manage permissions"
@@ -50,33 +51,34 @@ The description should be a link to the meeting issue.
5051

5152
You can edit title and description on YouTube at a later time if needed.
5253

53-
![](youtube-stream-title-description.png)
54+
![YouTube Basic Info example text](youtube-stream-title-description.png)
5455

5556
### Share the meeting once you've gone live
5657

5758
The meeting link should be `http://www.youtube.com/c/nodejs-foundation/live`.
5859

5960
Send it in a tweet such as:
60-
```
61+
62+
```text
6163
.@nodejs Technical Steering Committee meeting live now: http://www.youtube.com/c/nodejs-foundation/live
6264
```
6365

6466
Adjust the `Technical Steering Committee` part as necessary and remove the
6567
`.@nodejs` if tweeting from the official twitter account.
6668

67-
![](youtube-stream-share.png)
69+
![YouTube Share input box](youtube-stream-share.png)
6870

6971
## Check stream status
7072

7173
This should say online when you are streaming, and usually be green.
7274

7375
However, it may turn yellow and issue a warning in a "stream health" section below. Since we usually stream with static images for the video, there will often be warnings that the video bitrate is low. This is a not a problem and should almost always be ignored.
7476

75-
![](youtube-stream-status.png)
77+
![YouTube Stream Status showing Offline](youtube-stream-status.png)
7678

7779
## Check how many people are watching
7880

79-
![](youtube-stream-analytics.png)
81+
![YouTube Analytics graph](youtube-stream-analytics.png)
8082

8183
## Moderate the chat and solicit questions
8284

TSC-Charter.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Technical Steering Committee (TSC) Charter
22

3-
## Section 1. Guiding Principle.
3+
## Section 1. Guiding Principle
44

55
The Node.js project is part of the OpenJS Foundation which
66
operates transparently, openly, collaboratively, and ethically.
77
Project proposals, timelines, and status must not merely be
88
open, but also easily visible to outsiders.
99

10-
## Section 2. Evolution of OpenJS Foundation Governance.
10+
## Section 2. Evolution of OpenJS Foundation Governance
1111

1212
Most large, complex open source communities have both a business and a
1313
technical governance model. Technical leadership for the projects
@@ -26,7 +26,7 @@ additionally make amendments to the TSC charter at any time, though the
2626
CPC will not interfere with day-to-day discussions, votes or meetings
2727
of the TSC.
2828

29-
## Section 3. Establishment of the TSC.
29+
## Section 3. Establishment of the TSC
3030

3131
TSC memberships are not time-limited. There is no maximum size of the TSC.
3232
The size is expected to vary in order to ensure adequate coverage of important
@@ -68,7 +68,7 @@ participate in TSC discussions, *and* does not participate in TSC votes, the
6868
member shall be automatically removed from the TSC. The member may be invited
6969
to continue attending TSC meetings as an observer.
7070

71-
## Section 4. Responsibilities of the TSC.
71+
## Section 4. Responsibilities of the TSC
7272

7373
Subject to such policies as may be set by the CPC, the TSC is
7474
responsible for all technical development within the Node.js project,
@@ -87,7 +87,7 @@ projects.
8787

8888
The TSC will define Node.js project’s release vehicles.
8989

90-
## Section 5. Node.js Project Operations.
90+
## Section 5. Node.js Project Operations
9191

9292
The TSC will establish and maintain a development process for the Node.js
9393
project. The development process will establish guidelines

0 commit comments

Comments
 (0)