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.

Sign up for GitHub

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

Jump to bottom

Update contribute docs to clarify adding/running prettier locally #317

Open
brittanyjoiner15 opened this issue Oct 19, 2021 · 5 comments · May be fixed by #324
Open

Update contribute docs to clarify adding/running prettier locally #317

brittanyjoiner15 opened this issue Oct 19, 2021 · 5 comments · May be fixed by #324
Assignees
@menina763
Labels
Category: Documentation/Training Improvements or additions to documentation. Hacktoberfest

Comments

@brittanyjoiner15
Copy link
Contributor

Describe the bug

A clear and concise description of what the bug is.

It seems the prettier buid is failing on PRs that are coming from certain places. I think the fix might be to make sure that everyone who contributes has Prettier locally and runs the write and check functions on the files they're editing.

I would probably update the docs to reference: https://prettier.io/docs/en/install.html
@isabelcosta isabelcosta added Category: Documentation/Training Improvements or additions to documentation. Hacktoberfest Status: Available Issue was approved and available to claim or abandoned for over 3 days. labels Oct 20, 2021
@menina763
Copy link

@brittanyjoiner15 I would like to take up this issue but I just want to double-check: what we would need to do is mention in the contribute guidelines here that every contributor needs to have Prettier locally and run the write and check functions on their current files they're editing? Or only to the ones who are contributing to the programming issues?

@brittanyjoiner15
Copy link
Contributor Author

@Menina294 i believe it would be any contribution, unless you're contributing to something that's in the .prettierignore file (which will ignore those files), but even documentation is included in the formatting

@menina763
Copy link

Ahh okie dokie, then I would like to take up this issue please @brittanyjoiner15!

@isabelcosta isabelcosta removed the Status: Available Issue was approved and available to claim or abandoned for over 3 days. label Oct 20, 2021
@isabelcosta
Copy link
Member

It's yours @Menina294 :)

@menina763
Copy link

Heyy um @brittanyjoiner15, do you think you can help me out a bit? I thought I had commit the changes but I think I may have messed up 😅. It's been like 2 years since I've touched GitHub I think.

@menina763 menina763 linked a pull request Oct 22, 2021 that will close this issue
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@menina763 menina763

Labels
Category: Documentation/Training Improvements or additions to documentation. Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Add Prettier note on Contributing doc menina763/anitab-org.github.io
3 participants
@isabelcosta @brittanyjoiner15 @menina763