Skip to content

Commit 00a676d

Browse files
github-actions[bot]create-or-update-pull-requestbjohansebas
authored
Update external docs (#1922)
update external docs Co-authored-by: Create or Update Pull Request Action <create-or-update-pull-request@users.noreply.github.com> Co-authored-by: Sebastian Beltran <bjohansebas@gmail.com>
1 parent 308cdf4 commit 00a676d

3 files changed

Lines changed: 40 additions & 91 deletions

File tree

_includes/readmes/cookie-session.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ encrypting it, or use a server-side session instead.
2828

2929
**NOTE** This module does not prevent session replay, as the expiration set is that
3030
of the cookie only; if that is a concern of your application, you can store an expiration
31-
date in `req.session` object and validate it on the sever, and implement any other logic
31+
date in `req.session` object and validate it on the server, and implement any other logic
3232
to extend the session as your application needs.
3333

3434
## Install

_includes/readmes/multer.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@ on top of [busboy](https://github.com/mscdex/busboy) for maximum efficiency.
99

1010
This README is also available in other languages:
1111

12-
- [العربية](https://github.com/expressjs/multer/blob/master/doc/README-ar.md) (Arabic)
13-
- [Español](https://github.com/expressjs/multer/blob/master/doc/README-es.md) (Spanish)
14-
- [简体中文](https://github.com/expressjs/multer/blob/master/doc/README-zh-cn.md) (Chinese)
15-
- [한국어](https://github.com/expressjs/multer/blob/master/doc/README-ko.md) (Korean)
16-
- [Русский язык](https://github.com/expressjs/multer/blob/master/doc/README-ru.md) (Russian)
17-
- [Việt Nam](https://github.com/expressjs/multer/blob/master/doc/README-vi.md) (Vietnam)
18-
- [Português](https://github.com/expressjs/multer/blob/master/doc/README-pt-br.md) (Portuguese Brazil)
19-
- [Français](https://github.com/expressjs/multer/blob/master/doc/README-fr.md) (French)
20-
- [O'zbek tili](https://github.com/expressjs/multer/blob/master/doc/README-uz.md) (Uzbek)
12+
- [العربية](https://github.com/expressjs/multer/blob/main/doc/README-ar.md) (Arabic)
13+
- [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) (Spanish)
14+
- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (Chinese)
15+
- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (Korean)
16+
- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (Russian)
17+
- [Việt Nam](https://github.com/expressjs/multer/blob/main/doc/README-vi.md) (Vietnam)
18+
- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (Portuguese Brazil)
19+
- [Français](https://github.com/expressjs/multer/blob/main/doc/README-fr.md) (French)
20+
- [O'zbek tili](https://github.com/expressjs/multer/blob/main/doc/README-uz.md) (Uzbek)
2121

2222
## Installation
2323

2424
```sh
25-
$ npm install --save multer
25+
$ npm install multer
2626
```
2727

2828
## Usage
@@ -232,7 +232,7 @@ If no `filename` is given, each file will be given a random name that doesn't
232232
include any file extension.
233233

234234
**Note:** Multer will not append any file extension for you, your function
235-
should return a filename complete with an file extension.
235+
should return a filename complete with a file extension.
236236

237237
Each function gets passed both the request (`req`) and some information about
238238
the file (`file`) to aid with the decision.
@@ -308,7 +308,7 @@ When encountering an error, Multer will delegate the error to Express. You can
308308
display a nice error page using [the standard express way](http://expressjs.com/guide/error-handling.html).
309309

310310
If you want to catch errors specifically from Multer, you can call the
311-
middleware function by yourself. Also, if you want to catch only [the Multer errors](https://github.com/expressjs/multer/blob/master/lib/multer-error.js), you can use the `MulterError` class that is attached to the `multer` object itself (e.g. `err instanceof multer.MulterError`).
311+
middleware function by yourself. Also, if you want to catch only [the Multer errors](https://github.com/expressjs/multer/blob/main/lib/multer-error.js), you can use the `MulterError` class that is attached to the `multer` object itself (e.g. `err instanceof multer.MulterError`).
312312

313313
```javascript
314314
const multer = require('multer')
@@ -329,16 +329,16 @@ app.post('/profile', function (req, res) {
329329

330330
## Custom storage engine
331331

332-
For information on how to build your own storage engine, see [Multer Storage Engine](https://github.com/expressjs/multer/blob/master/StorageEngine.md).
332+
For information on how to build your own storage engine, see [Multer Storage Engine](https://github.com/expressjs/multer/blob/main/StorageEngine.md).
333333

334334
## License
335335

336336
[MIT](LICENSE)
337337

338-
[ci-image]: https://badgen.net/github/checks/expressjs/multer/master?label=ci
338+
[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg
339339
[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml
340-
[test-url]: https://coveralls.io/r/expressjs/multer?branch=master
341-
[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/master
340+
[test-url]: https://coveralls.io/r/expressjs/multer?branch=main
341+
[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main
342342
[npm-downloads-image]: https://badgen.net/npm/dm/multer
343343
[npm-url]: https://npmjs.org/package/multer
344344
[npm-version-image]: https://badgen.net/npm/v/multer

en/resources/contributing.md

Lines changed: 23 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ compromise among committers be the default resolution mechanism.
8888
### Becoming a Triager
8989

9090
Anyone can become a triager! Read more about the process of being a triager in
91-
[the triage process document](https://github.com/expressjs/express/blob/master/Triager-Guide.md).
91+
[the triage process document](https://github.com/expressjs/discussions/blob/master/Triager-Guide.md).
9292

9393
Currently, any existing [organization member](https://github.com/orgs/expressjs/people) can nominate
9494
a new triager. If you are interested in becoming a triager, our best advice is to actively participate
@@ -162,86 +162,26 @@ project for at least 6 months as a committer prior to the request. They should h
162162
helped with code contributions as well as triaging issues. They are also required to
163163
have 2FA enabled on both their GitHub and npm accounts.
164164

165-
Any TC member or an existing captain on the **same** repo can nominate another committer
166-
to the captain role. To do so, they should submit a PR to this document, updating the
167-
**Active Project Captains** section (while maintaining the sort order) with the project
165+
Any TC member or an existing captain on the **same** repo can nominate another committer
166+
to the captain role. To do so, they should submit a PR to this document, updating the
167+
**Active Project Captains** section (while maintaining the sort order) with the project
168168
name, the nominee's GitHub handle, and their npm username (if different).
169-
- Repos can have as many captains as make sense for the scope of work.
170-
- A TC member or an existing repo captain **on the same project** can nominate a new captain.
169+
170+
* Repos can have as many captains as make sense for the scope of work.
171+
* A TC member or an existing repo captain **on the same project** can nominate a new captain.
171172
Repo captains from other projects should not nominate captains for a different project.
172173

173-
The PR will require at least 2 approvals from TC members and 2 weeks hold time to allow
174-
for comment and/or dissent. When the PR is merged, a TC member will add them to the
174+
The PR will require at least 2 approvals from TC members and 2 weeks hold time to allow
175+
for comment and/or dissent. When the PR is merged, a TC member will add them to the
175176
proper GitHub/npm groups.
176177

177178
#### Active Projects and Captains
178179

179-
- [`expressjs/badgeboard`](https://github.com/expressjs/badgeboard): @wesleytodd
180-
- [`expressjs/basic-auth-connect`](https://github.com/expressjs/basic-auth-connect): @ulisesGascon
181-
- [`expressjs/body-parser`](https://github.com/expressjs/body-parser): @wesleytodd, @jonchurch, @ulisesGascon
182-
- [`expressjs/compression`](https://github.com/expressjs/compression): @ulisesGascon
183-
- [`expressjs/connect-multiparty`](https://github.com/expressjs/connect-multiparty): @ulisesGascon
184-
- [`expressjs/cookie-parser`](https://github.com/expressjs/cookie-parser): @wesleytodd, @UlisesGascon
185-
- [`expressjs/cookie-session`](https://github.com/expressjs/cookie-session): @ulisesGascon
186-
- [`expressjs/cors`](https://github.com/expressjs/cors): @jonchurch, @ulisesGascon
187-
- [`expressjs/discussions`](https://github.com/expressjs/discussions): @wesleytodd
188-
- [`expressjs/errorhandler`](https://github.com/expressjs/errorhandler): @ulisesGascon
189-
- [`expressjs/express-paginate`](https://github.com/expressjs/express-paginate): @ulisesGascon
190-
- [`expressjs/express`](https://github.com/expressjs/express): @wesleytodd, @ulisesGascon
191-
- [`expressjs/expressjs.com`](https://github.com/expressjs/expressjs.com): @crandmck, @jonchurch, @bjohansebas
192-
- [`expressjs/flash`](https://github.com/expressjs/flash): @ulisesGascon
193-
- [`expressjs/generator`](https://github.com/expressjs/generator): @wesleytodd
194-
- [`expressjs/method-override`](https://github.com/expressjs/method-override): @ulisesGascon
195-
- [`expressjs/morgan`](https://github.com/expressjs/morgan): @jonchurch, @ulisesGascon
196-
- [`expressjs/multer`](https://github.com/expressjs/multer): @LinusU, @ulisesGascon
197-
- [`expressjs/response-time`](https://github.com/expressjs/response-time): @UlisesGascon
198-
- [`expressjs/serve-favicon`](https://github.com/expressjs/serve-favicon): @ulisesGascon
199-
- [`expressjs/serve-index`](https://github.com/expressjs/serve-index): @ulisesGascon
200-
- [`expressjs/serve-static`](https://github.com/expressjs/serve-static): @ulisesGascon
201-
- [`expressjs/session`](https://github.com/expressjs/session): @ulisesGascon
202-
- [`expressjs/statusboard`](https://github.com/expressjs/statusboard): @wesleytodd
203-
- [`expressjs/timeout`](https://github.com/expressjs/timeout): @ulisesGascon
204-
- [`expressjs/vhost`](https://github.com/expressjs/vhost): @ulisesGascon
205-
- [`jshttp/accepts`](https://github.com/jshttp/accepts): @blakeembrey
206-
- [`jshttp/basic-auth`](https://github.com/jshttp/basic-auth): @blakeembrey
207-
- [`jshttp/compressible`](https://github.com/jshttp/compressible): @blakeembrey
208-
- [`jshttp/content-disposition`](https://github.com/jshttp/content-disposition): @blakeembrey
209-
- [`jshttp/content-type`](https://github.com/jshttp/content-type): @blakeembrey
210-
- [`jshttp/cookie`](https://github.com/jshttp/cookie): @blakeembrey
211-
- [`jshttp/etag`](https://github.com/jshttp/etag): @blakeembrey
212-
- [`jshttp/forwarded`](https://github.com/jshttp/forwarded): @blakeembrey
213-
- [`jshttp/fresh`](https://github.com/jshttp/fresh): @blakeembrey
214-
- [`jshttp/http-assert`](https://github.com/jshttp/http-assert): @wesleytodd, @jonchurch, @ulisesGascon
215-
- [`jshttp/http-errors`](https://github.com/jshttp/http-errors): @wesleytodd, @jonchurch, @ulisesGascon
216-
- [`jshttp/media-typer`](https://github.com/jshttp/media-typer): @blakeembrey
217-
- [`jshttp/methods`](https://github.com/jshttp/methods): @blakeembrey
218-
- [`jshttp/mime-db`](https://github.com/jshttp/mime-db): @blakeembrey, @UlisesGascon
219-
- [`jshttp/mime-types`](https://github.com/jshttp/mime-types): @blakeembrey, @UlisesGascon
220-
- [`jshttp/negotiator`](https://github.com/jshttp/negotiator): @blakeembrey
221-
- [`jshttp/on-finished`](https://github.com/jshttp/on-finished): @wesleytodd, @ulisesGascon
222-
- [`jshttp/on-headers`](https://github.com/jshttp/on-headers): @blakeembrey
223-
- [`jshttp/proxy-addr`](https://github.com/jshttp/proxy-addr): @wesleytodd, @ulisesGascon
224-
- [`jshttp/range-parser`](https://github.com/jshttp/range-parser): @blakeembrey
225-
- [`jshttp/statuses`](https://github.com/jshttp/statuses): @blakeembrey
226-
- [`jshttp/type-is`](https://github.com/jshttp/type-is): @blakeembrey
227-
- [`jshttp/vary`](https://github.com/jshttp/vary): @blakeembrey
228-
- [`pillarjs/cookies`](https://github.com/pillarjs/cookies): @blakeembrey
229-
- [`pillarjs/csrf`](https://github.com/pillarjs/csrf): @ulisesGascon
230-
- [`pillarjs/encodeurl`](https://github.com/pillarjs/encodeurl): @blakeembrey
231-
- [`pillarjs/finalhandler`](https://github.com/pillarjs/finalhandler): @wesleytodd, @ulisesGascon
232-
- [`pillarjs/hbs`](https://github.com/pillarjs/hbs): @ulisesGascon
233-
- [`pillarjs/multiparty`](https://github.com/pillarjs/multiparty): @blakeembrey
234-
- [`pillarjs/parseurl`](https://github.com/pillarjs/parseurl): @blakeembrey
235-
- [`pillarjs/path-to-regexp`](https://github.com/pillarjs/path-to-regexp): @blakeembrey
236-
- [`pillarjs/request`](https://github.com/pillarjs/request): @wesleytodd
237-
- [`pillarjs/resolve-path`](https://github.com/pillarjs/resolve-path): @blakeembrey
238-
- [`pillarjs/router`](https://github.com/pillarjs/router): @wesleytodd, @ulisesGascon
239-
- [`pillarjs/send`](https://github.com/pillarjs/send): @blakeembrey
240-
- [`pillarjs/understanding-csrf`](https://github.com/pillarjs/understanding-csrf): @ulisesGascon
180+
The list can be found at [https://github.com/expressjs/discussions/blob/HEAD/docs/contributing/captains_and_committers.md#active-projects-and-members](https://github.com/expressjs/discussions/blob/HEAD/docs/contributing/captains_and_committers.md#active-projects-and-members)
241181

242182
#### Current Initiative Captains
243183

244-
- Triage team [ref](https://github.com/expressjs/discussions/issues/227): @UlisesGascon
184+
The list can be found at [https://github.com/expressjs/discussions/blob/HEAD/docs/contributing/captains_and_committers.md#current-initiative-captains](https://github.com/expressjs/discussions/blob/HEAD/docs/contributing/captains_and_committers.md#current-initiative-captains)
245185

246186
### Developer's Certificate of Origin 1.1
247187

@@ -279,6 +219,8 @@ By making a contribution to this project, I certify that:
279219

280220
Open issues for the expressjs.com website in https://github.com/expressjs/expressjs.com.
281221

222+
For issues in other Express managed repos (everything in `expressjs`, `pillarjs` or `jshttp` other than `expressjs/express`), be sure to check their contributing guide and open issues and PRs in the appropriate repository.
223+
282224
### PRs and Code contributions
283225

284226
* Tests must pass.
@@ -290,14 +232,14 @@ Open issues for the expressjs.com website in https://github.com/expressjs/expres
290232
Use the `master` branch for bug fixes or minor work that is intended for the
291233
current release stream.
292234

293-
Use the correspondingly named branch, e.g. `5.0`, for anything intended for
235+
Use the correspondingly named branch, e.g. `6.x`, for anything intended for
294236
a future release of Express.
295237

296238
### Steps for contributing
297239

298-
1. [Create an issue](https://github.com/expressjs/express/issues/new) for the
240+
1. Create an issue for the
299241
bug you want to fix or the feature that you want to add.
300-
2. Create your own [fork](https://github.com/expressjs/express) on GitHub, then
242+
2. Create your own fork on GitHub, then
301243
checkout your fork.
302244
3. Write your code in your local copy. It's good practice to create a branch for
303245
each new issue you work on, although not compulsory.
@@ -325,6 +267,13 @@ Things that will help get your question issue looked at:
325267
If you post a question and do not outline the above items or make it easy for
326268
us to understand and reproduce your issue, it will be closed.
327269

270+
If your question meets all of the above requirements but you do not believe it needs to be looked at
271+
by the maintainers
272+
(for example, if you are just looking for community input) please open it as a discussion topic instead
273+
of an issue. If you
274+
are unsure and open an issue, we may move it to discussions if we triage them and decide they do
275+
not need high
276+
visibility or maintainer input.
328277
## Security Policies and Procedures
329278

330279
<!-- SRC: expressjs/express Security.md -->

0 commit comments

Comments
 (0)