-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Add sections to editor-setup about Prettier and ESLint #831
Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much for this @Princesseuh — this is really great. I’ve made some minor suggestions — mostly just punctuation or small style nits, but otherwise this LGTM! 💜
Co-authored-by: Chris Swithinbank <[email protected]>
Co-authored-by: Chris Swithinbank <[email protected]>
Co-authored-by: Chris Swithinbank <[email protected]>
Co-authored-by: Chris Swithinbank <[email protected]>
Co-authored-by: Chris Swithinbank <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Erika. Couple of more suggestions based on Sarah’s feedback and then you should be good to merge!
Co-authored-by: Chris Swithinbank <[email protected]>
Co-authored-by: Chris Swithinbank <[email protected]>
Co-authored-by: Chris Swithinbank <[email protected]>
What kind of changes does this PR include?
Description
Added a section to the Editor Setup page about how to setup Prettier and ESLint.
For ESLint, I opted to simply link the the plugin's User Guide. My reasoning being that being an unofficial plugin, changes might change the installation / configuration process without us noticing. (And it shouldn't be the burden of the community members maintaining it to update our docs, in my opinion.)
For Prettier, I documented how to install it and use it in a CLI scenario in our docs and left a link to the README for further information on how to use it in VS Code and possible settings. I however documented how to make it work in pnpm because it's an issue people encounter very very frequently, to the point where people often think the plugin is broken
This PR also fix a slight mistake in the remote url inside
CONTRIBUTING.md
Fix #425