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.

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

docs: make contributing.md more contributor-friendly #27913

Merged
merged 7 commits into from Aug 17, 2021

Conversation

ctjlewis
Copy link
Contributor

@ctjlewis ctjlewis commented Aug 10, 2021

I originally sought out to add a statement about chromedriver before investing time in making the document as clear as possible for new contributors on the first read. Any notes are very welcome.

  • add Ubuntu/Debian apt install chromedriver tip
  • consistent heading names, subheadings
  • formatting
  • order changes:
    1. Developing
    2. Building
    3. Testing
    4. Adding warning/error descriptions
    5. Adding examples

Documentation / Examples

  • Make sure the linting passes

I originally sought out to add a statement about chromedriver before investing time in making the document as clear as possible for new contributors on the first read. Any notes are very welcome.

- add `apt install chromium-chromedriver` tip
- consistent heading names, subheadings, general reorganization
- formatting, order changes
@ijjk

This comment has been minimized.

contributing.md Outdated Show resolved Hide resolved
@ctjlewis
Copy link
Contributor Author

Not sure why lint is failing, but contributing.md is the only file changed here and is passing, so can probably be safely ignored.

@ijjk

This comment has been minimized.

Copy link
Member

@leerob leerob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, thank you so much!

@ijjk

This comment has been minimized.

@ijjk
Copy link
Member

ijjk commented Aug 12, 2021

Failing test suites

Commit: f8fa614

test/acceptance/ReactRefreshLogBox.dev.test.js

  • server-side only compilation errors

Expand output

● server-side only compilation errors

ScriptTimeoutError: script timeout
  (Session info: headless chrome=92.0.4515.131)

  72 |
  73 |             // Wait for application to re-hydrate:
> 74 |             await browser.executeAsyncScript(function () {
     |             ^
  75 |               var callback = arguments[arguments.length - 1]
  76 |               if (window.__NEXT_HYDRATED) {
  77 |                 callback()

  at Object.throwDecodedError (../node_modules/selenium-webdriver/lib/error.js:550:15)
  at parseHttpResponse (../node_modules/selenium-webdriver/lib/http.js:565:13)
  at Executor.execute (../node_modules/selenium-webdriver/lib/http.js:491:26)
      at runMicrotasks (<anonymous>)
  at Proxy.execute (../node_modules/selenium-webdriver/lib/webdriver.js:700:17)
  at Object.patch (acceptance/helpers.js:74:13)
  at Object.<anonymous> (acceptance/ReactRefreshLogBox.dev.test.js:1422:3)

@ijjk

This comment has been minimized.

contributing.md Outdated Show resolved Hide resolved
contributing.md Outdated Show resolved Hide resolved
styfle
styfle previously approved these changes Aug 17, 2021
Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@ijjk
Copy link
Member

ijjk commented Aug 17, 2021

Stats from current PR

Default Build (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary ctjlewis/next.js patch-1 Change
buildDuration 13.4s 17s ⚠️ +3.7s
buildDurationCached 3.4s 3.3s -57ms
nodeModulesSize 61.5 MB 61.5 MB ⚠️ +2 B
Page Load Tests Overall increase ✓
vercel/next.js canary ctjlewis/next.js patch-1 Change
/ failed reqs 0 0
/ total time (seconds) 2.37 2.343 -0.03
/ avg req/sec 1054.86 1066.94 +12.08
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.33 1.312 -0.02
/error-in-render avg req/sec 1880.09 1905.62 +25.53
Client Bundles (main, webpack, commons)
vercel/next.js canary ctjlewis/next.js patch-1 Change
745.HASH.js gzip 179 B 179 B
framework-HASH.js gzip 42.2 kB 42.2 kB
main-HASH.js gzip 23.2 kB 23.2 kB
webpack-HASH.js gzip 1.44 kB 1.44 kB
Overall change 67.1 kB 67.1 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary ctjlewis/next.js patch-1 Change
polyfills-a4..dd70.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary ctjlewis/next.js patch-1 Change
_app-HASH.js gzip 979 B 979 B
_error-HASH.js gzip 194 B 194 B
amp-HASH.js gzip 312 B 312 B
css-HASH.js gzip 329 B 329 B
dynamic-HASH.js gzip 2.65 kB 2.65 kB
head-HASH.js gzip 351 B 351 B
hooks-HASH.js gzip 918 B 918 B
image-HASH.js gzip 4.13 kB 4.13 kB
index-HASH.js gzip 261 B 261 B
link-HASH.js gzip 1.66 kB 1.66 kB
routerDirect..HASH.js gzip 318 B 318 B
script-HASH.js gzip 387 B 387 B
withRouter-HASH.js gzip 320 B 320 B
bb14e60e810b..30f.css gzip 125 B 125 B
Overall change 12.9 kB 12.9 kB
Client Build Manifests
vercel/next.js canary ctjlewis/next.js patch-1 Change
_buildManifest.js gzip 492 B 492 B
Overall change 492 B 492 B
Rendered Page Sizes
vercel/next.js canary ctjlewis/next.js patch-1 Change
index.html gzip 539 B 539 B
link.html gzip 551 B 551 B
withRouter.html gzip 532 B 532 B
Overall change 1.62 kB 1.62 kB

Webpack 4 Mode (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary ctjlewis/next.js patch-1 Change
buildDuration 11.2s 11.1s -65ms
buildDurationCached 4.7s 4.7s -37ms
nodeModulesSize 61.5 MB 61.5 MB ⚠️ +2 B
Page Load Tests Overall increase ✓
vercel/next.js canary ctjlewis/next.js patch-1 Change
/ failed reqs 0 0
/ total time (seconds) 2.375 2.376 0
/ avg req/sec 1052.5 1052.02 ⚠️ -0.48
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.339 1.303 -0.04
/error-in-render avg req/sec 1866.5 1919.11 +52.61
Client Bundles (main, webpack, commons)
vercel/next.js canary ctjlewis/next.js patch-1 Change
16.HASH.js gzip 186 B 186 B
677f882d2ed8..HASH.js gzip 14.1 kB 14.1 kB
framework.HASH.js gzip 41.9 kB 41.9 kB
main-HASH.js gzip 10.6 kB 10.6 kB
webpack-HASH.js gzip 1.19 kB 1.19 kB
Overall change 68 kB 68 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary ctjlewis/next.js patch-1 Change
polyfills-a4..dd70.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary ctjlewis/next.js patch-1 Change
_app-HASH.js gzip 964 B 964 B
_error-HASH.js gzip 3.8 kB 3.8 kB
amp-HASH.js gzip 552 B 552 B
css-HASH.js gzip 333 B 333 B
dynamic-HASH.js gzip 2.85 kB 2.85 kB
head-HASH.js gzip 3.06 kB 3.06 kB
hooks-HASH.js gzip 924 B 924 B
index-HASH.js gzip 231 B 231 B
link-HASH.js gzip 1.64 kB 1.64 kB
routerDirect..HASH.js gzip 298 B 298 B
script-HASH.js gzip 2.98 kB 2.98 kB
withRouter-HASH.js gzip 295 B 295 B
30809af5c834..565.css gzip 125 B 125 B
Overall change 18.1 kB 18.1 kB
Client Build Manifests
vercel/next.js canary ctjlewis/next.js patch-1 Change
_buildManifest.js gzip 500 B 500 B
Overall change 500 B 500 B
Rendered Page Sizes
vercel/next.js canary ctjlewis/next.js patch-1 Change
index.html gzip 585 B 585 B
link.html gzip 597 B 597 B
withRouter.html gzip 578 B 578 B
Overall change 1.76 kB 1.76 kB
Commit: 804aeb1

@kodiakhq kodiakhq bot merged commit baeb98e into vercel:canary Aug 17, 2021
@vercel vercel locked as resolved and limited conversation to collaborators Jan 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants