From 70b6ea46385684b6820fb44137a3ee235d7efaa7 Mon Sep 17 00:00:00 2001 From: Vedran Kasalica Date: Tue, 3 Dec 2024 18:21:01 +0100 Subject: [PATCH 1/2] Migrate Code quality to Best Practices chapter --- .DS_Store | Bin 0 -> 8196 bytes _sidebar.md | 1 - best_practices/code_quality.md | 17 ----------------- best_practices/overview.md | 16 ++++++++++++++++ 4 files changed, 16 insertions(+), 18 deletions(-) create mode 100644 .DS_Store delete mode 100644 best_practices/code_quality.md diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..e131af3bfb8f3b68be7e25ca93317313ab2c2e2f GIT binary patch literal 8196 zcmeHM-ELAr5dIdhrO>n*6YY)hyg*5O1LP;BiDF{$y7CW&LQ`lWcibCa!B;Roj1S|L zelxo^d-gytjmF*NoS}QZZ)W$KS;(9MFtywM3*ZDmk(bzqW!|<7c`jFG!O|qHvh1wecPmhzevCkly_`(j9t2?{lv527`d}Ip7?SBgjh(Fy-23 z;o9+%Ul2#$+KXf?iSCJazP(tcBj9U*FXKYB>J!~XhpY+}>IW=FLB)%5MC^dP71`J1 zbQo_%#dx3d8KwpW+0-7&M+A#22%u~9Dc z^F;jw>gA>8eD*$Gb5C_Nxxe#J39UIFU1qE`)g5z%1FlfsW@T1bkgD@pkC;=*=+v$6 zlwRaaP3hs1SzlnD&VW=^>I5AI9(M3F$NtGXV8)uvaYM4aHCvKvpYcTNe8$~%wC+zC znP-tJp73wkcYoKaHS@l&J+0`Dt>p9$bE80`l49jV$~lk Date: Wed, 4 Dec 2024 15:09:10 +0100 Subject: [PATCH 2/2] add RSQkit link to code quality section of best practices chapter Co-authored-by: fdiblen <144492+fdiblen@users.noreply.github.com> --- best_practices/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/best_practices/overview.md b/best_practices/overview.md index 060d3b6c..98d19517 100644 --- a/best_practices/overview.md +++ b/best_practices/overview.md @@ -26,7 +26,7 @@ Tests are important for two reasons: 1. confirming the expected workings of your Ways to improve code quality are described in the [Code quality](https://book.the-turing-way.org/reproducible-research/code-quality.html) chapter on the Turing Way. Explore [online tools for software quality improvement](https://book.the-turing-way.org/reproducible-research/code-quality/code-quality-style.html#online-services-providing-software-quality-checks). Additionally, check our [language guides](/language_guides/languages_overview.md) for language-specific recommendations. - +[RSQKit: Research Software Quality Kit](https://everse.software/RSQKit/) also has many useful guides including software quality. These guides are result of an international collaboration primarily focusing on research software quality. ### EditorConfig The eScience Center provides a [shared config file](https://raw.githubusercontent.com/NLeSC/exemplum/master/.editorconfig) for IDEs and text editors. This file helps standardize coding styles across projects.