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: how to use with testing frameworks #1623

Conversation

brenno263
Copy link
Contributor

@brenno263 brenno263 commented Dec 1, 2022

Fixes #1324

Add a documentation page about integrating with testing frameworks.

I sort of wish I had more to add besides examples, but Faker is pretty straightforward to use. There were a number of quirks to document with frameworks, but at the time of writing everything significant has been smoothed over to my knowledge.

Please let me know if there's anything I should add.

@brenno263 brenno263 requested a review from a team December 1, 2022 04:04
@brenno263 brenno263 requested a review from a team as a code owner December 1, 2022 04:04
@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Dec 1, 2022
@ST-DDT
Copy link
Member

ST-DDT commented Dec 1, 2022

Please fix the merge conflicts.

@ST-DDT ST-DDT added the needs rebase There is a merge conflict label Dec 1, 2022
@import-brain import-brain removed the needs rebase There is a merge conflict label Dec 2, 2022
Copy link
Member

@ST-DDT ST-DDT left a comment

Choose a reason for hiding this comment

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

Could you also add hints regarding faker.seed and test snapshots?

docs/guide/frameworks.md Show resolved Hide resolved
docs/guide/frameworks.md Outdated Show resolved Hide resolved
docs/guide/frameworks.md Outdated Show resolved Hide resolved
docs/guide/frameworks.md Outdated Show resolved Hide resolved
docs/guide/frameworks.md Show resolved Hide resolved
docs/guide/frameworks.md Outdated Show resolved Hide resolved
docs/guide/frameworks.md Outdated Show resolved Hide resolved
docs/guide/frameworks.md Outdated Show resolved Hide resolved
docs/guide/frameworks.md Outdated Show resolved Hide resolved
@ST-DDT ST-DDT added the s: accepted Accepted feature / Confirmed bug label Dec 2, 2022
@codecov
Copy link

codecov bot commented Dec 2, 2022

Codecov Report

Merging #1623 (7c37b8d) into next (d0ff3fe) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##             next    #1623   +/-   ##
=======================================
  Coverage   99.62%   99.62%           
=======================================
  Files        2222     2222           
  Lines      240500   240500           
  Branches     1066     1066           
=======================================
  Hits       239598   239598           
  Misses        881      881           
  Partials       21       21           

@Shinigami92 Shinigami92 changed the title feat(documentation): Add a documentation page for how to use faker with testing frameworks #1324 docs: how to use with testing frameworks Dec 5, 2022
docs/guide/frameworks.md Outdated Show resolved Hide resolved
docs/guide/frameworks.md Outdated Show resolved Hide resolved
docs/guide/frameworks.md Outdated Show resolved Hide resolved
docs/guide/frameworks.md Show resolved Hide resolved
docs/guide/frameworks.md Outdated Show resolved Hide resolved
@brenno263 brenno263 requested review from ST-DDT and Shinigami92 and removed request for ST-DDT and Shinigami92 December 6, 2022 00:34
Shinigami92
Shinigami92 previously approved these changes Dec 6, 2022
docs/guide/frameworks.md Outdated Show resolved Hide resolved
docs/guide/frameworks.md Outdated Show resolved Hide resolved
docs/guide/frameworks.md Outdated Show resolved Hide resolved
Copy link
Member

@ST-DDT ST-DDT left a comment

Choose a reason for hiding this comment

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

Just some minor nit-picking, other than that this looks good to me.

docs/guide/frameworks.md Outdated Show resolved Hide resolved
docs/guide/frameworks.md Outdated Show resolved Hide resolved
docs/guide/frameworks.md Outdated Show resolved Hide resolved
brenno263 and others added 3 commits December 6, 2022 16:42
Co-authored-by: ST-DDT <ST-DDT@gmx.de>
Co-authored-by: ST-DDT <ST-DDT@gmx.de>
Co-authored-by: ST-DDT <ST-DDT@gmx.de>
@ST-DDT ST-DDT requested review from Shinigami92 and a team December 6, 2022 23:09
@ST-DDT ST-DDT merged commit 6baa8ce into faker-js:next Dec 8, 2022
@brenno263
Copy link
Contributor Author

It was a pleasure working with you guys!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add a documentation page for how to use faker with testing frameworks
4 participants