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: .github/pull_request_template.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,3 +22,4 @@ Choose the right checklist for the change that you're making:
22
22
## Documentation / Examples
23
23
24
24
-[ ] Make sure the linting passes by running `yarn lint`
25
+
-[ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)
Copy file name to clipboardExpand all lines: contributing.md
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -265,7 +265,17 @@ Below are the steps to add a new link:
265
265
266
266
## Adding examples
267
267
268
-
When you add an example to the [examples](examples) directory, don’t forget to add a `README.md` file with the following format:
268
+
When you add an example to the [examples](examples) directory, please follow these guidelines to ensure high quality examples:
269
+
270
+
- TypeScript should be leveraged for new examples (no need for separate JavaScript and TypeScript examples)
271
+
- Examples should not add custom ESLint configuration (we have specific templates for ESLint)
272
+
- If API routes aren't used in an example, they should be omitted
273
+
- If an example exists for a certain library and you would like to showcase a specific feature of that library, the existing example should be updated (instead of adding a new example)
274
+
- Package manager specific config should not be added (e.g. `resolutions` in `package.json`)
275
+
- In `package.json` the version of `next` (and `eslint-config-next`) should be `latest`
276
+
- In `package.json` the dependency versions should be up-to-date
277
+
278
+
Also don’t forget to add a `README.md` file with the following format:
269
279
270
280
- Replace `DIRECTORY_NAME` with the directory name you’re adding.
Copy file name to clipboardExpand all lines: docs/api-reference/next/image.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
@@ -55,7 +55,7 @@ When using `layout="intrinsic"`, `layout="fixed"`, or `layout="raw"`, the `width
55
55
56
56
When using `layout="responsive"`, `layout="fill"`, the `width` property represents the _original_ width in pixels, so it will only affect the aspect ratio.
57
57
58
-
The `width` property is required, except for [statically imported images](#local-images), or those with `layout="fill"`.
58
+
The `width` property is required, except for [statically imported images](/docs/basic-features/image-optimization.md#local-images), or those with `layout="fill"`.
59
59
60
60
### height
61
61
@@ -65,7 +65,7 @@ When using `layout="intrinsic"`, `layout="fixed"`, or `layout="raw"`, the `heigh
65
65
66
66
When using `layout="responsive"`, `layout="fill"`, the `height` property represents the _original_ height in pixels, so it will only affect the aspect ratio.
67
67
68
-
The `height` property is required, except for [statically imported images](#local-images), or those with `layout="fill"`.
68
+
The `height` property is required, except for [statically imported images](/docs/basic-features/image-optimization.md#local-images), or those with `layout="fill"`.
0 commit comments