From 8e0a989c50090f9dab1517d161866358688b1de5 Mon Sep 17 00:00:00 2001 From: Ludwig Muench Date: Thu, 14 Nov 2019 16:17:06 -0500 Subject: [PATCH 1/3] update readme to explain what engineering guides are and what not --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 73a21f8..2be7e23 100644 --- a/README.md +++ b/README.md @@ -1 +1,21 @@ # SB Engineering Guides +The SB Engineering Guides provide a way to document processes and best practices that have established themselves over time or resulted from spikes and meetings. + +Rather than just capturing `what` they should also document `why` in the form of discussions of a pull request. + +The following table should help you decide if something should go in a guide or not: + +| Do | Don't | +| ---------------------------------------------------| ------------------------------------------------------------- | +| Internal processes (onboarding, PR's, Jira issues) | Things that can be automated (e.g. by a linter and formatter) | +| Link to external guides (e.g. AirBnB Style Guide) | Write guides based on personal style / preferences | +| Link to external docs and tutorials | Write everything by hand and not keep it up-to-date | +| Core tech stack (tools, frameworks, libraries) | Exotic / unmaintained libraries | + +If there is something missing or out-of-date in the guides, feel free to create a [GitHub issue](https://github.com/smashingboxes/sb-engineering-guides/issues) or a pull request (see [CONTRIBUTING.md](./frontend.md)). + +## Table of Contents +- [Backend](./backend.md) +- [DevOps](./devops.md) +- [Frontent](./frontend.md) +- [Mobile](./mobile.md) From 8cb1ca660f1b5a1b56726443535cb9689b8f336c Mon Sep 17 00:00:00 2001 From: Ludwig Muench Date: Thu, 14 Nov 2019 16:23:49 -0500 Subject: [PATCH 2/3] update wording --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2be7e23..9e09592 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # SB Engineering Guides The SB Engineering Guides provide a way to document processes and best practices that have established themselves over time or resulted from spikes and meetings. -Rather than just capturing `what` they should also document `why` in the form of discussions of a pull request. +Rather than just capturing how we do things at SB, this shall repo also document why we do it that way in the form of discussions inside a pull request. The following table should help you decide if something should go in a guide or not: From 328545323b82aa7c907e9971e8d84f14249ee9c6 Mon Sep 17 00:00:00 2001 From: ludwigmuench <50423338+ludwigmuench@users.noreply.github.com> Date: Thu, 14 Nov 2019 13:36:19 -0800 Subject: [PATCH 3/3] Update README.md Co-Authored-By: Derek Kniffin --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9e09592..8977776 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # SB Engineering Guides The SB Engineering Guides provide a way to document processes and best practices that have established themselves over time or resulted from spikes and meetings. -Rather than just capturing how we do things at SB, this shall repo also document why we do it that way in the form of discussions inside a pull request. +Rather than just capturing how we do things at SB, this repo shall also document why we do it that way in the form of discussions inside a pull request. The following table should help you decide if something should go in a guide or not: