archive/rsnext
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rsnext/contributing/core/adding-error-links.md
Balázs Orbán 3ff21ed178
refactor: split up CONTRIBUTING.md (#40515) 
Continues #39778

Closes #40499

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the
feature request has been accepted for implementation before opening a
PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have helpful link attached, see `contributing.md`

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm lint`
- [ ] The examples guidelines are followed from [our contributing
doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)

Co-authored-by: Tim Neutkens <tim@timneutkens.nl>
Co-authored-by: JJ Kasper <jj@jjsweb.site>
2022-09-16 14:54:58 -07:00

570 B
Raw Blame History

Adding Warning and Error Descriptions

Next.js has a system to add helpful links to warnings and errors.

This allows the logged message to be short while giving a broader description and instructions on how to solve the warning/error on the documentation.

In general, all warnings and errors added should have these links attached.

Below are the steps to add a new link:

  1. Run pnpm new-error which will create the error document and update the manifest automatically.
  2. At the end of the command the URL for the error will be provided, add that to your error.