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: readme cleanup #251

Merged
merged 4 commits into from
Jan 25, 2022
Merged

docs: readme cleanup #251

merged 4 commits into from
Jan 25, 2022

Conversation

CalebBurton
Copy link
Contributor

@CalebBurton CalebBurton commented Jan 21, 2022

  • replace non-ASCII punctuation with ASCII equivalent (e.g. --> ")
  • typo fix: schems --> schema
  • re-add documentation for the random module, which was mistakenly removed in 11116da (all of the methods were removed instead of only the deprecated methods)
  • clarify that the random.boolean() and random.image() methods are deprecated
  • change contribution examples to use pnpm since that's now required as of a273f67 addressed by chore(test): migrate to vitest #235
  • add pnpm build to the examples, since otherwise they will throw an error addressed by chore(test): migrate to vitest #235

@CalebBurton CalebBurton requested a review from a team as a code owner January 21, 2022 17:37
@netlify
Copy link

netlify bot commented Jan 21, 2022

✔️ Deploy Preview for vigilant-wescoff-04e480 ready!

🔨 Explore the source changes: f029709

🔍 Inspect the deploy log: https://app.netlify.com/sites/vigilant-wescoff-04e480/deploys/61eb28593d9f2c0007a0ed15

😎 Browse the preview: https://deploy-preview-251--vigilant-wescoff-04e480.netlify.app

@Shinigami92
Copy link
Member

I will reevaluate this after #155 was merged
So there will be some conflicts and you need to rebase when that is merged

@CalebBurton
Copy link
Contributor Author

Oh, good! I hadn't seen that, I'll rebase off that branch and work at resolving the conflicts proactively

@Shinigami92
Copy link
Member

You can now rebase

Shinigami92
Shinigami92 previously approved these changes Jan 21, 2022
@Shinigami92 Shinigami92 added the c: chore PR that doesn't affect the runtime behavior label Jan 21, 2022
@import-brain import-brain added the c: docs Improvements or additions to documentation label Jan 21, 2022
import-brain
import-brain previously approved these changes Jan 21, 2022
- replace non-ASCII punctuation with ASCII equivalent (e.g. `“` --> `"`)
- typo fix: schems --> schema
- typo fix: uses --> using
@CalebBurton
Copy link
Contributor Author

Rebased again to resolve new merge conflicts

@Shinigami92 Shinigami92 requested a review from a team January 21, 2022 21:46
@Shinigami92 Shinigami92 merged commit bbc67aa into faker-js:main Jan 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: chore PR that doesn't affect the runtime behavior c: docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants