Skip to content
Siddharth Rawat edited this page Dec 12, 2023 · 11 revisions

Intro

Microservices, containers, and container orchestration have fundamentally changed how distributed systems are developed. This course covers a collection of repeatable, generic software design patterns such as Sidecar pattern, Ambassador pattern, Adapter pattern, Event-Driven, Stream & Batch Processing, Containers & Container Orchestration, Replication, Partitioning, Transactions, Consistency, and Consensus to help make the development of reliable distributed systems more approachable and efficient. We try to find useful ways of thinking about distributed systems and just how they work, but also why they work, and what questions we need to ask. After going through the codebase, you will be in a great position to decide which kind of technology is appropriate for which purpose and understand how these patterns can be combined to form the foundation of good application architecture. The code aims to help build skills to develop applications for hybrid cloud and run existing monolithic applications side by side with microservices without a complete rewrite.

Code Quality

Here are a few things in order to maintain code quality and structure when working with a team of engineers:

Given a version number MAJOR.MINOR.PATCH, increment the:

  • MAJOR version when you make incompatible API changes
  • MINOR version when you add functionality in a backward compatible manner
  • PATCH version when you make backward compatible bug fixes

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.

The commit message should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

The commit contains the following structural elements, to communicate intent to the consumers of your library:

  • fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
  • feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
  • BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
  • types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.
  • footers other than BREAKING CHANGE: <description> may be provided and follow a convention similar to git trailer format.

Additional types are not mandated by the Conventional Commits specification, and have no implicit effect in Semantic Versioning (unless they include a BREAKING CHANGE). A scope may be provided to a commit’s type, to provide additional contextual information and is contained within parenthesis, e.g., feat(parser): add ability to parse arrays.

Clone this wiki locally