Memex icon indicating copy to clipboard operation
Memex copied to clipboard

[WIP] Memex coding guidelines

Open ShishKabab opened this issue 5 years ago • 5 comments

View it here, rather than in the diff: https://github.com/WorldBrain/Memex/blob/docs/memex-dev-guide/docs/Coding-Guidelines.md

First todos:

  • [ ] Links to TDD examples
  • [x] Integrate link to Bob Martin video in nice way
  • [ ] Add action links to issue templates in Workflow section

Remember when content is OK:

  • [ ] Spelling/grammar check

ShishKabab avatar Apr 11 '19 11:04 ShishKabab

@poltak I've just added some React-specific guidelines: https://github.com/WorldBrain/Memex/blob/docs/memex-dev-guide/docs/Coding-Guidelines.md#react-specfic-guidelines

Don't know yet about state being passed down, because that's preferable to other solutions. But, I could be wrong and you have a different situation in mind.

If you're happy with this so far, I'd say to link to it in the main docs, merge it, and keep iterating on it.

ShishKabab avatar Jun 12 '19 15:06 ShishKabab

Cheers @ShishKabab! I did a read over this stuff again, and fixed up some minor issues I found. I also added that link from the main getting started doc.

Don't know yet about state being passed down, because that's preferable to other solutions. But, I could be wrong and you have a different situation in mind.

We've probably discussed this before, but what's the issue here exactly? Certain states will need to be passed down to stateless components/views. I don't see a problem there, but there's probably some good examples of bad ways state can be passed around

poltak avatar Jun 13 '19 03:06 poltak

what's the issue here exactly?

I don't know, just found it in your list on Notion: https://www.notion.so/worldbrain/Creating-UI-guidelines-4ea4053b39854e3699f9ee2e3a7842f5#04d3829969b2425985f62aa4c08c6ea6

ShishKabab avatar Jun 13 '19 08:06 ShishKabab

And thanks for the contributions! Should really enable spellcheck in my text editor :P

ShishKabab avatar Jun 13 '19 08:06 ShishKabab

@ShishKabab What do we do with this one I guess if there is no new information added, lets merge it in?

blackforestboi avatar Sep 09 '19 17:09 blackforestboi