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

add Prettier formatting to the project #180

Open
thescientist13 opened this issue Dec 2, 2024 · 2 comments
Open

add Prettier formatting to the project #180

thescientist13 opened this issue Dec 2, 2024 · 2 comments
Labels
chore good first issue Good for newcomers

Comments

@thescientist13
Copy link
Member

Type of Change

Chore

Summary

As new contributions are coming into the project, it would be good to formalize the formatting style and expectations for the project, and for that it would probably a good idea to add Prettier to the project.

There's an example we can follow from the Greenwood website that I implemented that we can follow
https://github.com/ProjectEvergreen/www.greenwoodjs.dev

Details

A couple notes regarding the above reference repo

  • I opted to incorporate husky for managing pre-commit hooks, but I am OK if we just want to just have it so contributors manually run prettier format locally.
  • Either way, we should still have prettier format run on CI as part of our GitHub Actions flow
  • We should probably also upgrade to ESLint to the latest version and make sure it has any prettier overlapping rules disabled. Here's that's project's ESLint config for reference (we don't need the markdown configuration though)
  • We should add a note to the CONTRIBUTING.md with whatever workflow we end up with

As we have a few PRs and release in active development, my recommendation would be to wait until all those PRs land first, or just do it as the first change once we cut the v0.16.0 release
https://github.com/ProjectEvergreen/wcc/issues?q=label%3A0.16.0+

@thescientist13
Copy link
Member Author

@briangrider
I know we had chatted about this one, so just mentioning you here in case you were interested in contributing the change.

@briangrider
Copy link

Ok, great. Yes, definitely up for helping with this but agree that we can wait until we get all of the other good stuff we've been talking about in there

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore good first issue Good for newcomers
Projects
Status: 🔖 Ready
Development

No branches or pull requests

2 participants