From 75649f208f3e7e519da716271a92146d50ae7a83 Mon Sep 17 00:00:00 2001 From: Gregor Gololicic <75445744+sideninja@users.noreply.github.com> Date: Wed, 12 May 2021 17:30:10 +0200 Subject: [PATCH 1/2] Update CONTRIBUTING.md add guideline on too much result data --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 332dee36c..dbd4e978c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -242,6 +242,9 @@ Default command response should be to the stdout and not saved to a file. Anytim the output to be saved to a file we should explicitly specify so by using `--save filename.txt` flag and providing the path. +Result output should include only information that is commonly used and releavant, +don't use too much of user screen drowning what’s truly important, +instead provide a way to include that data when the user requests by having include, exclude flags. ``` Address 179b6b1cb6755e31 From 8096f2143a61158e8681e1467bc2d5c1b49bd240 Mon Sep 17 00:00:00 2001 From: Gregor Gololicic <75445744+sideninja@users.noreply.github.com> Date: Thu, 13 May 2021 19:02:58 +0200 Subject: [PATCH 2/2] Update CONTRIBUTING.md Co-authored-by: Peter Siemens --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbd4e978c..642d7fb35 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -242,7 +242,7 @@ Default command response should be to the stdout and not saved to a file. Anytim the output to be saved to a file we should explicitly specify so by using `--save filename.txt` flag and providing the path. -Result output should include only information that is commonly used and releavant, +Result output should include only information that is commonly used and relevant, don't use too much of user screen drowning what’s truly important, instead provide a way to include that data when the user requests by having include, exclude flags.