Skip to content

docs: add prettier instructions #385

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nick-fallon
Copy link
Collaborator

Overview

Clarify the need for using prettier for code formatting.

Copy link

netlify bot commented Jul 14, 2025

👷 Deploy request for chrisvogt pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 4ebbbb6

Copy link

codecov bot commented Jul 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.35%. Comparing base (4c50f75) to head (4ebbbb6).

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #385   +/-   ##
=======================================
  Coverage   97.35%   97.35%           
=======================================
  Files          80       80           
  Lines        1097     1097           
  Branches      316      316           
=======================================
  Hits         1068     1068           
  Misses         26       26           
  Partials        3        3           
Flag Coverage Δ
unittests 97.35% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Owner

@chrisvogt chrisvogt left a comment

Choose a reason for hiding this comment

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

Are you open to updating the pre-commit hooks as well? The two hooks in here are only running ESLint and should run Prettier as well. pre-commit will auto-fix, and pre-push is report only (yarn prettier --check .).

5. Commit your changes: `git commit -m 'Add amazing feature'`
6. Push to the branch: `git push origin feature/amazing-feature`
7. Open a Pull Request
5. Run `yarn prettier --write ..` to automatically fix formatting issues
Copy link
Owner

Choose a reason for hiding this comment

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

.. will run it in the directory above this.

Suggested change
5. Run `yarn prettier --write ..` to automatically fix formatting issues
5. Run `yarn prettier --write .` to automatically fix formatting issues

@chrisvogt chrisvogt self-requested a review July 14, 2025 07:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants