From c3bebaa76c0d92fbea1581b13220e90c4c09635e Mon Sep 17 00:00:00 2001 From: Thomas Eizinger Date: Mon, 31 Oct 2022 18:46:52 +1100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Andre Hofmeister <9199345+HofmeisterAn@users.noreply.github.com> --- DESIGN_PRINCIPLES.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/DESIGN_PRINCIPLES.md b/DESIGN_PRINCIPLES.md index 7e8edd67..98d6ea05 100644 --- a/DESIGN_PRINCIPLES.md +++ b/DESIGN_PRINCIPLES.md @@ -1,11 +1,11 @@ # Design principles -This documents aims to capture the design principles that went into this library. +This document aims to capture the design principles that went into this library. It should serve as a reference point when making decisions on what features to include or exclude. ## Simple -One of most important goals that we want to adhere to is creating a _simple_ API. +One of the most important goals that we want to adhere to is creating a _simple_ API. Overall, this means keeping the API as small as possible to get the task done. When in doubt, we'd rather not add flags or configuration options for certain use cases.