/Powtoon-Programming-Guide

How we code nicely and correctly in sync with each other

Primary LanguageJavaScript

Powtoon Programming Guide

This programming guide was forged from a several highly trending guides that with a personal touch.

The primary goal of the guide is to ensure that modern best practices that are widely agreed upon in the huge JavaScript, React, and Functional Programming communities are held throughout our whole project.

The secondary goal, that is very important as well, is to make sure everybody style their code the same. This can partly be achieved with linting but some rules are not and those who are still better be documented, discussed, explained, exemplified and understood.

It is important to notice that some parts are highly debated in the community and will be surely debated between us as well (even on a biblical scale :P) but nevertheless we should all stick to the guide.

Changing the guide should be relatively easy and the whole company should be highly encouraged to influence it.

The guide consists of several parts:

  • The Clean Code Guide is about general programming best practises and conventions considering the nature of the JavaScript language and our strive to use Functional Programming.

  • The React Guide where we sync how we use react.

  • The CSS Guide where we sync how we use css.

  • The Style Guide where we sync our style of programming and syntax so it looks the same all over the project.