futwebapp-tampermonkey icon indicating copy to clipboard operation
futwebapp-tampermonkey copied to clipboard

Enforce a coding standard

Open Mardaneus86 opened this issue 5 years ago • 6 comments

Issue placeholder to enforce a coding standard throughout to project.

Also add proper contribution guidelines for Pull Requests to the Readme and/or repository.

Mardaneus86 avatar Oct 14 '18 11:10 Mardaneus86

Some suggestions from my point of view:

Regaddi avatar Oct 16 '18 05:10 Regaddi

I recommend using prettier: https://github.com/prettier/prettier just because it imposes opinion about code formatting, and takes the decision out of developer hands.

pratik60 avatar Oct 21 '18 10:10 pratik60

@pratik60 I don't think there is much need for prettier since the project is already using the even more popular airbnb javascript guidelines.

Regaddi avatar Oct 21 '18 10:10 Regaddi

Prettier is great because you don't have to think about the javascript guidelines, as with editor plugins it autosaves it in the right format. Its removes friction from code reviews, or the cognitive overload so that you don't have to think about js guidelines.

Cool to not have it, was just a suggestion.

pratik60 avatar Oct 21 '18 12:10 pratik60

Same applies to the eslint config by Airbnb 😊 On top of code style it contains also rules to prevent code smells

Regaddi avatar Oct 21 '18 12:10 Regaddi

Definitely consider adding Prettier. I would hate to work on a codebase that doesn't have it nowadays—it's one of those things you don't truly appreciate until it isn't there any more.

hamishtaplin avatar Dec 13 '18 19:12 hamishtaplin