From 49466bacf4c946cb21570c94ac5d3792338cdbb3 Mon Sep 17 00:00:00 2001 From: Jake Freeberg Date: Mon, 5 Feb 2024 08:32:42 -0600 Subject: [PATCH] Just starting the Readme (#2) * Just starting to get the Readme * added links to the guts of the guide --- README.md | 33 ++++++++++++++++++++++++++++----- 1 file changed, 28 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7e5b38e49f..470162d2ae 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,31 @@ # SPSCommerce/typescript -todo: write basic documentation... +## What? -- what is this -- why is this -- how is this -- who is this +About 10 years ago, AirBnB's engineers created a style guide and explained their reasoning in this way: "Everyone writes JavaScript a little differently. We finally decided it was time that we got together and agree on how we write JavaScript." SPS Commerce engineers have talked about the need for unified lint rules and a style guide for almost as long, but in 2022 we all new development is done in Typescript instead of Javascript. In this guide we've taken what we feel are the best parts of the AirBnB guide and made it our own. + +It is broken down in to 3 sections: + +- [Typescript](./typescript/) +- [React](./react/) +- [CSS in JS](./css-in-js/) + +## Why? + +Our goal is to ensure that similar syntax and developer experience exists across teams and projects at SPS Commerce. + +## How? + +This is the hard part to write, but we'll get there soon... + +## Who? + +The work to define this guide and choose which rules were include was done by the SPS Frontend Architecture Working group in 2021. + +- Christopher Nordhougen ([@cnordhougen](https://github.com/cnordhougen)) +- Justin Turner ([@turnerjw](https://github.com/turnerjw)) +- Dima Surkov ([@DimaSurkov](https://github.com/DimaSurkov)) +- Jake Freeberg ([@jakefreeberg](https://github.com/jakefreeberg)) +- Alex Ivakhnenko([@alexander-ivakhnenko](https://github.com/alexander-ivakhnenko)) +- Ihor Kuzmenko ([@IgorKuzmenko](https://github.com/IgorKuzmenko)) +- Andy Sciro ([@spssciro](https://github.com/spssciro))