From b590c398a39b449a66ccd3a2be4d0c7784f225a6 Mon Sep 17 00:00:00 2001 From: Joel Hoekstra Date: Fri, 24 Mar 2017 15:24:16 +0100 Subject: [PATCH] added the bettercodehub reflection and updated the readme. --- BETTERCODEHUB.md | 34 ++++++++++++++++++++++++++++++++++ README.md | 9 ++++++++- 2 files changed, 42 insertions(+), 1 deletion(-) create mode 100644 BETTERCODEHUB.md diff --git a/BETTERCODEHUB.md b/BETTERCODEHUB.md new file mode 100644 index 0000000..de91f07 --- /dev/null +++ b/BETTERCODEHUB.md @@ -0,0 +1,34 @@ +[![BCH compliance](https://bettercodehub.com/edge/badge/HanzehogeschoolSICT/Sorting)](https://bettercodehub.com/) +# Bettercodehub evaluatie +Dit project heeft een 9 van de 10. Het is geen 10 doordat er een afwezigheid is van Tests. Er zal ten alle tijden nog verbeteringen aangebracht kunnen worden en deze zullen hieronder worden beschreven. Hiernaast zal er in de toekomst ook gekeken moeten worden naar Unit Testing. + + +## Write Short Units of Code +Er zijn nog enkele methodes die over het limiet van 15 regels gaan en hier zou dan nog een refactor slag voor uitgevoerd kunnen worden. + +## Write Simple Units of Code +Alle code is zo te lezen dat het eenvoudig te begrijpen is. + +## Write Code Once +Er zijn nog een paar regels redunant in de code. Dit zou verbeterd kunnen worden door te abstraheren. + +## Keep Unit Interfaces Small +Alle methoden hebben vier of minder parameters. Het zou nog verbeterd kunnen worden door ze nog meer in te korten. Dat is in deze situatie een overbodig. + +## Seperate Concerns in Modules +De klasse AbstractSort is in dit systeem iets te veel verbonden met verschillende modulen. Dit weegt vrij weinig mee doordat het een abstracte klasse is voor de verschillende sorteer algoritmes. + +## Couple Architecture Components Loosely +De code is vrij goed van elkaar los gekoppeld en hoeft hierdoor weinig van elkaar te weten om te kunnen functioneren. + +## Keep Architecture Components Balanced +De gewichten van de componenten zijn goed doordat de code goed is opgesplitst naar aanleiding van functionaliteit. + +## Keep your Codebase Small +De grootte van de code is erg klein 0.08 jaar. Hierdoor dus in de goede range van 0 tot en met 20 jaar. + +## Automate Tests +De code wordt niet getest. Hierdoor is er geen zekerheid in functionaliteit wanneer er een wijziging plaatsvind. + +## Write Clean Code +De code is goed te onderhouden en bevat geen tot weinig nutteloze commentaren, geen slechte namen voor methoden en variabelen. \ No newline at end of file diff --git a/README.md b/README.md index ea347f3..4572e81 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ [![BCH compliance](https://bettercodehub.com/edge/badge/HanzehogeschoolSICT/Sorting)](https://bettercodehub.com/) -# Sorting +# Sorting algorithms +This is the sorting algorithms assignment for Hanzehogeschool ICT. It is created by Joël Hoekstra. + +## Supported Sorting algorithms +This assignment supports the Bubble Sort, Insertion Sort and the Quick Sort algorithms. ## Usage tips To use a different sorter change comments in the jlsa.sorting.controller.App class and the start method. + +## Bettercodehub reflection +The reflection can be read [here](https://github.com/HanzehogeschoolSICT/Sorting/blob/master/BETTERCODEHUB.md). \ No newline at end of file