Skip to content

Commit

Permalink
Just starting the Readme (#2)
Browse files Browse the repository at this point in the history
* Just starting to get the Readme

* added links to the guts of the guide
  • Loading branch information
jakefreeberg authored Feb 5, 2024
1 parent 759d447 commit 49466ba
Showing 1 changed file with 28 additions and 5 deletions.
33 changes: 28 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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))

0 comments on commit 49466ba

Please sign in to comment.