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: Add Prettier note on Contributing doc #324

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

menina763
Copy link

Description

Include a text about having Prettier installed and reminder to run write and check functions on current file(s).

Fixes #317

Type of Change:

  • Documentation

How Has This Been Tested?

Checklist:

  • My PR follows the style guidelines of this project
  • I have performed a self-review of my own code or materials
  • I have commented my code or provided relevant documentation, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • Any dependent changes have been merged

@menina763
Copy link
Author

@brittanyjoiner15 Soo I may just contradict the very things that I wrote in the doc lol. Umm should I get rid of this PR and try to have Prettier installed? I'm afraid that I may have messed up on it.

Copy link
Member

@isabelcosta isabelcosta left a comment

Choose a reason for hiding this comment

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

@Menina294 this is looking good :) I think you could also include a section on the README, explaining is the command to install and run prettier. You could do:

### Run linter

To install linter run this command: `yarn install prettier`
To run, use this command: `prettier ...`

I am not sure what are the exact commands, but this is an idea of how it could look like :)
cc @brittanyjoiner15

@ftonato ftonato mentioned this pull request Oct 22, 2021
2 tasks
@brittanyjoiner15
Copy link
Contributor

@isabelcosta and @Menina294 we actually might want to put this on hold until we figure out what's happening with #325 - just in case that changes anything, but yes in general I think you probably should just need some lines like @isabelcosta drafted above! I think the additional line would be the prettier write command, which I'm adding in here:

### Run linter

To install linter run this command: `npm install --save-dev --save-exact prettier` or `yarn add --dev --exact prettier`
To lint the code, run `npx prettier --write .` or `yarn prettier --write .` or `

@Menina294 let me know if you need any help with the commits and stuff! I know it's a little nerve-wracking sometimes. I prefer using the Github Desktop client, because it helps make it more clear! But basically you'll create a new branch, then make changes to your code in your editor (basically adding the section above into the contribution.md file), and then in the Github desktop you can just push that blue button in the bottom left that says "commit changes", and then it will pop up another blue button in the middle/top of the app that says "publish branch" and then "create pull request". Click each of those and it will open up a page in here to create a PR. Just fill out that info, and you'll be good to go!

@menina763
Copy link
Author

Ahh okay. Thanks for letting me know @brittanyjoiner15!

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.

Update contribute docs to clarify adding/running prettier locally
3 participants