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 linting instructions to CONTRIBUTING.md. #122

Open
HarshKapadia2 opened this issue Dec 12, 2022 · 3 comments
Open

Add Prettier linting instructions to CONTRIBUTING.md. #122

HarshKapadia2 opened this issue Dec 12, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@HarshKapadia2
Copy link
Member

HarshKapadia2 commented Dec 12, 2022

  • File to be changed: CONTRIBUTING.md
  • We need to inform contributors that we have a linting check in place.
    • This can be added as a note below the 'Tech Stack' section.
      • Eg: > NOTE: This repository has a Prettier code linting CI check. Please follow the Prettier instructions mentioned below.
  • We also need to inform contributors that they need to use Prettier before committing and provide instructions to do so.
    • Instructions should be provided for each type of environment, the Gitpod Setup and the Local Setup.
    • Instructions should be pertaining to how Prettier can be added/installed and which commands to execute or what method to follow to use Prettier.

Credits: @tusharnankani (in a PR comment)

@HarshKapadia2 HarshKapadia2 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 12, 2022
@KartikSoneji
Copy link
Member

Also mention how to enable the pre-commit hook if they want to as per #126

@HarshKapadia2
Copy link
Member Author

A good video to understand and set up Prettier: https://www.youtube.com/watch?v=DqfQ4DPnRqI

@tusharnankani
Copy link
Member

Thank you, this helped!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants