Coding Guidelines

Spaghetti belongs on plates, not in our codebase.

We're huge on clean code. Code will be read more than it is written. Thankfully you don't have to memorize all of the conventions, as most of them have been automated by ESLint.

If you have the ESLint extension in your IDE, you will immediately see some annoying red and yellow squigglies underneath your code. Thankfully, most of these squigglies can be made to go away using the format command in your IDE, or by running pnpm lint:fix in your terminal.

Refactoring

Refactoring is a misleading term, as the factoring part needs to happen first.

Let's say we have:

$$c = x + xy$$

We can make it easier to read by factoring out the x:

$$c = x(1 + y)$$

This is great, and we can go even further:

$$\begin{align*} c &= x^2\left(\frac{1}{x} + \frac{y}{x}\right) \\ &= x^3\left(\frac{1}{x^2} + \frac{y}{x^2}\right) \\ &= x^4\left(\frac{1}{x^3} + \frac{y}{x^3}\right) \end{align*}$$

Now compare the two equations, which one is easier to understand?

Now take this concept and apply it to code. You'll find that the parallels are uncanny.

People before reading the Knowledge Base: 🐈

People after reading the Knowledge Base: 🐅