update frontend guidance

dwarvesf / playbook

Guides for getting things done, programming well, and programming in style.

https://memo.d.foundation

230 stars 50 forks source link

update frontend guidance #46

Closed zlatanpham closed 2 years ago

zlatanpham commented 2 years ago

Update a new frontend guidance

[x] Tech stack
[x] Code style
[x] How to write tests

trankhacvy commented 2 years ago

Let a few comments. Others LGTM

zlatanpham commented 2 years ago

These points are probably extra:

A debugging story for using common logging patterns or a debugger on the browser or VSCode: https://nextjs.org/docs/advanced-features/debugging, especially now that breakpoint shifting in VSCode has been solved: vercel/next.js#30435

Inclusion of a quick Storybook guide, if the tool is GA on our side

Fair enough. We also need to add error logging section as well. I will make the update in a subsequent PR.

tienan92it commented 2 years ago

LGTM

Below is some practical principles for writing cleaner code:

Early returns for readability (The bouncer pattern). Ref: https://rikschennink.nl/thoughts/the-bouncer-pattern/
Apply sort-imports. Ref: https://eslint.org/docs/latest/rules/sort-imports
From the Google Closure Library Style Guide:
- functionNames
- variableNames
- ConstructorNames
- EnumNames
- methodNames
- SYMBOLIC_CONSTANTS