Skip to content

update readme based on allhands meeting discussion #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

update readme based on allhands meeting discussion #15

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e0a989
update readme to explain what engineering guides are and what not
ludwigmuench Nov 14, 2019
8cb1ca6
update wording
ludwigmuench Nov 14, 2019
3285453
Update README.md
ludwigmuench Nov 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 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:

| 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)