anitab-org.github.io icon indicating copy to clipboard operation
anitab-org.github.io copied to clipboard

Update contribute docs to clarify adding/running prettier locally

Open brittanyjoiner15 opened this issue 3 years ago • 5 comments

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

brittanyjoiner15 avatar Oct 19 '21 20:10 brittanyjoiner15

@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?

menina763 avatar Oct 20 '21 17:10 menina763

@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

brittanyjoiner15 avatar Oct 20 '21 17:10 brittanyjoiner15

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

menina763 avatar Oct 20 '21 17:10 menina763

It's yours @Menina294 :)

isabelcosta avatar Oct 20 '21 17:10 isabelcosta

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 avatar Oct 22 '21 02:10 menina763