feat(docs): add codebase best practices (#42591)

* feat(docs): add codebase best practices

* add anchor to linter setup

* add typescript highlighting, and basic idea

* apply silly standards

Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>

* add stateful class component example

Co-authored-by: Tom <20648924+moT01@users.noreply.github.com>

* encourage use of functional components

* split filename extension

Co-authored-by: Nicholas Carrigan (he/him) <nhcarrigan@gmail.com>

* add comments for future me

* add redux structure

* add tsx to prism imports

Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>
Co-authored-by: Tom <20648924+moT01@users.noreply.github.com>
Co-authored-by: Nicholas Carrigan (he/him) <nhcarrigan@gmail.com>
This commit is contained in:
Shaun Hamilton
2021-07-06 15:30:09 +01:00
committed by GitHub
parent ceb0b0f403
commit 2f729976fc
4 changed files with 313 additions and 150 deletions

View File

@ -19,7 +19,7 @@ We also support Windows 10 via WSL2, which you can prepare by [reading this guid
Some community members also develop on Windows 10 natively with Git for Windows (Git Bash), and other tools installed on Windows. We do not have official support for such a setup at this time, we recommend using WSL2 instead.
**Prerequisites:**
#### Prerequisites:
| Prerequisite | Version | Notes |
| --------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------- |
@ -42,7 +42,7 @@ npm -v
Once you have the prerequisites installed, you need to prepare your development environment. This is common for many development workflows, and you will only need to do this once.
**Follow these steps to get your development environment ready:**
##### Follow these steps to get your development environment ready:
1. Install [Git](https://git-scm.com/) or your favorite Git client, if you haven't already. Update to the latest version; the version that came bundled with your OS may be outdated.