/Best Practice

What Makes A Good Changelog

- Herbert Lui Zeno Rocha tl;dr: Changelogs are a must for developer tooling. We explore 5 important aspects of a good changelog, from images to formatting, and how to customize your changelog to communicate effectively to your users.

featured in #252

Your E-Mail Validation Logic is Wrong

- Jan Schaumann tl;dr: There's are lots of nuances validating addresses that are not accounted for. Jan highlights 13 examples, such as email addresses can contain multiple @s, punctuation character are allowed, bang paths can be accepted, the percent sign may lead to relaying, and more.

featured in #233

A Survey Of Git Best Practices

- David Golden tl;dr: David researched articles around Git best practices for a work presentation and collated the most frequently practices, in this post.

featured in #204

Very Short Functions Are A Code Smell – An Overview Of The Science On Function Length

tl;dr: "Considering that short functions tend to lead to longer debug times and that very short functions tend to have higher defect densities (both in historical and modern datasets) the case for using very short functions becomes weak."

featured in #203

Best Practices For Setting SLOs And SLIs For Modern, Complex Systems

- Elisa Binette tl;dr: A framework for SLIs and SLOs, Elisa concludes with 6 things to remember, including (1) define SLIs and SLOs for specific capabilities at system boundaries. (2) Each logical instance of a system (for example, a database shard) gets its own SLO.

featured in #202

Write Good Commit Messages

- Dan Moore tl;dr: "Focus on the intent of the change, not the mechanics. Why was this change needed? What drove it? What would you want to know about this reasoning or decision a year from now? What would you want a new team member approaching this code base to know?"

featured in #196

Array Functions and the Rule of Least Power

- Jesse Duffield tl;dr: "The tradeoff between the computational power of a language and the ability to determine what a program in that language is doing." Built-in array functions like .map & .filter may seem powerful but reduce flexibility. Jesse recommends custom code for readability and error reduction.

featured in #194

Best Practices For Managing And Storing Secrets Including API Keys And Other Credentials

- Mackenzie Jackson tl;dr: "Secrets management doesn’t have a one-size-fits-all approach so this list considers multiple perspectives so you can be informed in deciding to, or not to, implement strategies."

featured in #188

Encouraging A Culture Of Written Communication

- Maarten Claes tl;dr: As remote work becomes a normal, written communication becomes more critical. Good is the enemy of great - employees should be encouraged to write imperfectly to share ideas. Best practices are outlined here. 

featured in #183

Product For Internal Platforms

- Camille Fournier tl;dr: The role of building products for your own engineering team requires atypical product management. Camille discusses how it's unique, and her approach. 

featured in #183