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

Update Jest examples and docs #31633

Merged
merged 32 commits into from
Nov 30, 2021
Merged

Conversation

delbaoliveira
Copy link
Contributor

This PR updates the with-jest example to use the new built-in configuration with SWC. It also creates a new with-jest-babel with the recommended configuration for those who opt-out of SWC.

Docs have also been updated to include both examples.

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

docs/testing.md Outdated Show resolved Hide resolved
docs/testing.md Outdated Show resolved Hide resolved
docs/testing.md Outdated Show resolved Hide resolved
docs/testing.md Outdated Show resolved Hide resolved
docs/testing.md Outdated Show resolved Hide resolved
docs/testing.md Outdated Show resolved Hide resolved
docs/testing.md Outdated Show resolved Hide resolved
docs/testing.md Outdated Show resolved Hide resolved
docs/testing.md Outdated Show resolved Hide resolved
docs/testing.md Outdated Show resolved Hide resolved
examples/with-jest-babel/pages/index.js Show resolved Hide resolved
Co-authored-by: Lee Robinson <[email protected]>
docs/testing.md Outdated Show resolved Hide resolved
docs/testing.md Show resolved Hide resolved
docs/testing.md Outdated Show resolved Hide resolved
@@ -247,51 +247,86 @@ Jest and React Testing Library are frequently used together for **Unit Testing**

### Quickstart
Copy link
Collaborator

Choose a reason for hiding this comment

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

I wonder if I'm being pedantic here, what are your thoughts on converting this into steps, using the same heading titles?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Could you expand on what you mean here? 😊

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sorry. I just mean, would It be clearer for us to explain the QuickStart as a set of steps:

## Step 1: install

## Step2: do something else

This may not be the case here. I don't have a hard and fast rule on this, I just think it makes skimming content easier, you can drop in a a step if need etc.. I don't think this fits in all cases, was wondering what your thoughts are with this section.

I quite like how you have done it tbh, just raising the question. ☺️

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, thank you! I agree with you, it's good to give people context at the start. As you said, I'm not sure how the steps would fit this case, but I've added a quick summary here. wdyt?

delbaoliveira and others added 2 commits November 22, 2021 13:38
Co-authored-by: Lee Robinson <[email protected]>
Co-authored-by: Lee Robinson <[email protected]>
docs/testing.md Outdated Show resolved Hide resolved
docs/testing.md Outdated Show resolved Hide resolved
leerob
leerob previously approved these changes Nov 29, 2021
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.

Nice work! @molebox has one outstanding comment, but I think you've addressed it 🙏

Copy link
Collaborator

@molebox molebox left a comment

Choose a reason for hiding this comment

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

LGTM

@leerob leerob merged commit 306c467 into vercel:canary Nov 30, 2021
@vercel vercel locked as resolved and limited conversation to collaborators Jan 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
examples Issue/PR related to examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants