Style Guides

Consistency is the most important part of any process that requires a low-latency high-throughput system. There is something about having conventions rather than rules, and I remember people saying this 10 years ago. I didn’t understand it then, and I barely understand it now. Hopefully this post will guide the reader where I’ve been lost.

I will do a generative ai image post soon!

Be strict when sending and tolerant when receiving

Tim ‘Internet’ , section 3.9

I like the idea of being flexible in what you receive and strict in what you send. This is a guideline Tim Lee had when he invented the web. It is a great philosophy or “code to live by”

So is this just bike shedding?

There is it this term and kind of a story around this concept of a committee that has an endowment and wants to build a park… (sorry fellas)

In the world of project management and software development, a peculiar phenomenon known as “bike shedding” can have significant implications on productivity and team dynamics. Derived from an analogy coined by philosopher P.J. Plauger, bike shedding refers to the tendency for groups to spend a disproportionate amount of time and energy discussing and debating minor or trivial issues, often at the expense of more important, complex matters.

Mixtral24
What color we want boys? — This will be used in in-painting post 🙂

Big Picture

  • Where do we host repository?
  • What is main branch, is it svn-trunk style, patch email
  • collab rules
  • syntax rules…
  • … welcome to giant corp or crazy small corp

Devil is in the Details

  • Budget
  • Timeline
  • Lawyers
  • Technology Stack (truly this might be hell discussion but it should be agreed on)

Focus on details that matter, ignore sticky stuff until you can’t. Don’t lock yourself into a bad design. Keep an open mind. For me this is the hardest part.

Scaling Scopes

To be able to jump between the two views. System Level vs. The Weeds. I will continue this after it marinates for a bit. But the gist is being able to jump between parts of the graph of the system at various zoom levels. This is the key to being a successful engineer. The “application” needs to stay in “production”


Remarks

I will start a running list of style guides for repositories that I think are reasonable. Feel free to submit more.