Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update contributing doc and PR template for examples #37193

Merged
merged 3 commits into from
May 26, 2022
Merged

Update contributing doc and PR template for examples #37193

merged 3 commits into from
May 26, 2022

Conversation

ijjk
Copy link
Member

@ijjk ijjk commented May 25, 2022 •
edited
Loading

This adds some guidelines we would like to encourage for adding examples to help ensure we maintain good quality examples and to make reviewing easier.

Documentation / Examples

  • Make sure the linting passes by running yarn lint

x-ref: slack thread

@ijjk ijjk added the created-by: Next.js team PRs by the Next.js team. label May 25, 2022
@ijjk ijjk marked this pull request as ready for review May 25, 2022 16:09
@ijjk ijjk requested a review from leerob May 25, 2022 16:11
styfle
styfle reviewed May 25, 2022
View reviewed changes
contributing.md Outdated Show resolved Hide resolved
styfle
styfle reviewed May 25, 2022
View reviewed changes
contributing.md Outdated Show resolved Hide resolved
styfle
styfle reviewed May 25, 2022
View reviewed changes
contributing.md Outdated Show resolved Hide resolved
styfle
styfle reviewed May 25, 2022
View reviewed changes
contributing.md Outdated Show resolved Hide resolved
styfle
styfle reviewed May 25, 2022
View reviewed changes
contributing.md Outdated Show resolved Hide resolved
@ijjk @styfle
Apply suggestions from code review
75d45d8 
Co-authored-by: Steven <steven@ceriously.com>
@ijjk
Copy link
Member Author

ijjk commented May 25, 2022 •
edited
Loading

Stats from current PR

Default Build (Decrease detected ✓)
General
vercel/next.js canary ijjk/next.js docs/example-guidelines Change
buildDuration 18s 17.8s -192ms
buildDurationCached 7.2s 7.2s -73ms
nodeModulesSize 494 MB 494 MB ✓
Page Load Tests Overall decrease ⚠️
vercel/next.js canary ijjk/next.js docs/example-guidelines Change
/ failed reqs 0 0 ✓
/ total time (seconds) 4.443 4.415 -0.03
/ avg req/sec 562.64 566.19 +3.55
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.49 1.507 ⚠️ +0.02
/error-in-render avg req/sec 1677.39 1659.17 ⚠️ -18.22
Client Bundles (main, webpack)
vercel/next.js canary ijjk/next.js docs/example-guidelines Change
925.HASH.js gzip 179 B 179 B ✓
framework-HASH.js gzip 42 kB 42 kB ✓
main-HASH.js gzip 29.2 kB 29.2 kB ✓
webpack-HASH.js gzip 1.54 kB 1.54 kB ✓
Overall change 73 kB 73 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary ijjk/next.js docs/example-guidelines Change
polyfills-HASH.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary ijjk/next.js docs/example-guidelines Change
_app-HASH.js gzip 1.36 kB 1.36 kB ✓
_error-HASH.js gzip 193 B 193 B ✓
amp-HASH.js gzip 308 B 308 B ✓
css-HASH.js gzip 327 B 327 B ✓
dynamic-HASH.js gzip 2.71 kB 2.71 kB ✓
head-HASH.js gzip 359 B 359 B ✓
hooks-HASH.js gzip 920 B 920 B ✓
image-HASH.js gzip 5.74 kB 5.74 kB ✓
index-HASH.js gzip 263 B 263 B ✓
link-HASH.js gzip 2.65 kB 2.65 kB ✓
routerDirect..HASH.js gzip 320 B 320 B ✓
script-HASH.js gzip 391 B 391 B ✓
withRouter-HASH.js gzip 318 B 318 B ✓
85e02e95b279..7e3.css gzip 107 B 107 B ✓
Overall change 16 kB 16 kB ✓
Client Build Manifests
vercel/next.js canary ijjk/next.js docs/example-guidelines Change
_buildManifest.js gzip 459 B 459 B ✓
Overall change 459 B 459 B ✓
Rendered Page Sizes
vercel/next.js canary ijjk/next.js docs/example-guidelines Change
index.html gzip 533 B 533 B ✓
link.html gzip 546 B 546 B ✓
withRouter.html gzip 528 B 528 B ✓
Overall change 1.61 kB 1.61 kB ✓
Default Build with SWC (Increase detected ⚠️)
General
vercel/next.js canary ijjk/next.js docs/example-guidelines Change
buildDuration 19.5s 19.9s ⚠️ +378ms
buildDurationCached 7.3s 7.2s -104ms
nodeModulesSize 494 MB 494 MB ✓
Page Load Tests Overall increase ✓
vercel/next.js canary ijjk/next.js docs/example-guidelines Change
/ failed reqs 0 0 ✓
/ total time (seconds) 4.552 4.365 -0.19
/ avg req/sec 549.23 572.74 +23.51
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.539 1.465 -0.07
/error-in-render avg req/sec 1624.34 1706.98 +82.64
Client Bundles (main, webpack)
vercel/next.js canary ijjk/next.js docs/example-guidelines Change
925.HASH.js gzip 178 B 178 B ✓
framework-HASH.js gzip 42.7 kB 42.7 kB ✓
main-HASH.js gzip 29.7 kB 29.7 kB ✓
webpack-HASH.js gzip 1.54 kB 1.54 kB ✓
Overall change 74 kB 74 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary ijjk/next.js docs/example-guidelines Change
polyfills-HASH.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary ijjk/next.js docs/example-guidelines Change
_app-HASH.js gzip 1.35 kB 1.35 kB ✓
_error-HASH.js gzip 179 B 179 B ✓
amp-HASH.js gzip 311 B 311 B ✓
css-HASH.js gzip 324 B 324 B ✓
dynamic-HASH.js gzip 2.89 kB 2.89 kB ✓
head-HASH.js gzip 357 B 357 B ✓
hooks-HASH.js gzip 920 B 920 B ✓
image-HASH.js gzip 5.84 kB 5.84 kB ✓
index-HASH.js gzip 261 B 261 B ✓
link-HASH.js gzip 2.78 kB 2.78 kB ✓
routerDirect..HASH.js gzip 322 B 322 B ✓
script-HASH.js gzip 392 B 392 B ✓
withRouter-HASH.js gzip 317 B 317 B ✓
85e02e95b279..7e3.css gzip 107 B 107 B ✓
Overall change 16.4 kB 16.4 kB ✓
Client Build Manifests
vercel/next.js canary ijjk/next.js docs/example-guidelines Change
_buildManifest.js gzip 457 B 457 B ✓
Overall change 457 B 457 B ✓
Rendered Page Sizes
vercel/next.js canary ijjk/next.js docs/example-guidelines Change
index.html gzip 533 B 533 B ✓
link.html gzip 547 B 547 B ✓
withRouter.html gzip 529 B 529 B ✓
Overall change 1.61 kB 1.61 kB ✓
Commit: e24c233

@ijjk ijjk merged commit 7206614 into vercel:canary May 26, 2022
@ijjk ijjk deleted the docs/example-guidelines branch May 26, 2022 01:24
This was referenced May 26, 2022
Merged
Merged
kodiakhq bot pushed a commit that referenced this pull request May 26, 2022
@balazsorban44
Update contributing doc and PR template for examples (#37215)
3c764fc 
Follow-up on #37193

## 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 `yarn lint`
- [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 25, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@styfle styfle styfle approved these changes

@timneutkens timneutkens Awaiting requested review from timneutkens

@shuding shuding Awaiting requested review from shuding

@huozhi huozhi Awaiting requested review from huozhi

@padmaia padmaia Awaiting requested review from padmaia

@balazsorban44 balazsorban44 Awaiting requested review from balazsorban44

@leerob leerob Awaiting requested review from leerob

Assignees
No one assigned
Labels
created-by: Next.js team PRs by the Next.js team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ijjk @styfle