Engineering Playbook
Purpose
Within Truss we have much experience of and opinions regarding engineering tools, processes, and practices. The problems and choices that we encounter in our day-to-day practice are rarely new. Having a straightforward way of applying the things we collectively know to the problems we face would be a source of great efficiency for us.
This collection of documents is intended to be simple and searchable, each one containing the essence of Truss opinions on a particular topic. Whilst any Trussel is free to edit these documents, there is some expectation that these are to be curated by the broad engineering community at Truss. To that end, proposed changes should be submitted via a PR and SMEs will be identified to act as curators for particular areas of knowledge.
Public repo
One question we might ask is whether or not this repo should be public? My inclination is to say yes and use it as a way of demonstrating to customers and potential hires what to expect from working with or for Truss.
Contents
- Developer Tools & Practice - Opinions and resources relating to the tools we use to do our work
- Documentation - How to write effective documentation your users will read.
- Web Development - Languages, frameworks and tools used to develop web applications
- Infrastructure/Deployment - DevOps, Infrastructure ... call it what you will, somehow that application needs to get out into production and been maintained once it gets there.
- Security - The world is not as nice as we would like it to be. What should we do about that? What should we not be afraid of, despite what people say?
- Templates - "Ooh, ooh... I have a thing to add." Here's how to add to this Playbook
Initial Setup
Install Dependencies(Mac OS)
brew update
brew install pre-commit
pre-commit install