Merge branch 'update-documentation' into 'master'

Update makingRelease3 and springboot README

Closes #122 and #121

See merge request it1901/groups-2022/gr2205/gr2205!148

docs/release3/makingRelease3.md

@@ -4,8 +4,11 @@ I dette dokumentet drøfter vi over hva som har gått bra og hva som har gått d
 
 ## Hva har funket?
 Pipelines har vært en stor hjelp når vi har sendt merge requests for å sikre at programmet ikke ødelegges av koden som merges. Jacoco har også hjulpet mye med å se hvilke deler av koden som mangler testing, og har gjort det lett å finne hvilke metoder som mangler testdekning. Noe som også hjalp en del var at vi delte inn i arbeidsområder på starten av innleveringen, slik at hvert gruppemedlem hadde en egen del av prosjektet de fokuserte ekstra på. To personer utviklet ui og kontroller, en person lagde REST-API, og den siste utvidet tester og skrev brukerhistorier.
+
 I denne versjonen av appen begynte vi med å kommentere koden vår med javadoc. Slik ble det mye lettere å holde styr på funksjonene og hva de gjorde. Vi hadde også en god arbeidsvane ved å sitte sammen mens vi programmerte. Slik kunne vi raskt og effektiv få hverandre til å godta merge requester og kommentere eventuelle forbedringer.
 
+Til denne innleveringen begynte vi å bruke mer parprogrammering. Dette følte vi fungerte veldig bra. Å programmere sammen gjorde oss mye mer effektive, ettersom man mye lettere kan løse vanskelige problemer sammen enn alene.
+
 ## Hva har ikke funket?
 På noen tidspunkter fikk vi veldig mange merge requests som vi ikke skulle merge enda. Dette skjedde fordi flere av merge requestene endret på de samme filene. Etter forrige innlevering ble vi enige om å lage brukerhistoriene tidlig i prosessen. Vi føler idéen var god, men siden de siste brukerhistoriene ble lagd så kort etter brukerhistoriene til innlevering 2 så ble de veldig like og dekket mye av de samme områdene. Noe som også ikke har funket særlig godt er at vi har måttet oppdatere og endre testene flere ganger av ulike grunner. Core testene måtte blant annet endres på en del ettersom kjernestrukturen gikk gjennom en ganske stor endring med implementasjonen av checklists, og flere av metodene byttet navn og virkemåte. Ui testene måtte deaktiveres store deler av denne arbeidsprosessen fordi controlleren gikk gjennom noen store endringer i hvordan den behandlet Board, Note og Checklist klassene. (Se strukturelle endringer)
 
@@ -14,4 +17,6 @@ Et mer teknisk problem vi støtte på, var at json ikke søtter inheritance. Sli
 ## Strukturelle endringer
 Vi endret alle getters i koden til å returnere en kopi av objektet istedenfor selve objektet. Dette gjorde vi for å sikre god innkapsling. Vi har også gjort det slik at hvert element på en oppslagstavle har en egen controller. Dette gjorde vi for å slippe å kjøre matematiske kalkulasjoner for å finne indeksen på et element hver gang det skulle gjøres endringer. Dette fungerte mye bedre enn metodene vi brukte før, men gjorde også at ui testene ble helt utdaterte.
 
+Vi har fått tilbakemelding fra studass om å legge ved issuer i merge request-titlene. Dette valgte vi å ikke gjøre fordi vi allerede hadde lagt ved de relevante issuene i beskrivelsen til merge requestene. For å være konsekvente mellom de ulike innleveringene, valgte vi derfor å fortsette med å kun legge ved de relevante issuene i beskrivelsen, framfor til i tittelen, av merge requester.
+
 Originalt hadde vi planer om å legge til funksjon for å "feste" notater og sjekklister, altså å velge hvilke notater og sjekklister som skal dukke opp øverst på skjermen. Denne planen forkastet vi fordi vi bestemte oss for at det var viktigere ting å fokusere på, som å lage et godt REST-API. Det samme gjelder ideen vi hadde om å legge til at brukeren kunne endre farger på notater.

script/README.md

@@ -2,9 +2,9 @@
 
 Script er en enkel app som lar en bruker opprette, redigere, sortere og slette notater og sjekklister. Videre dokumentasjon til de forskjellige utgivelsene finnes i [/docs](/docs).
 
-Under er det et skjermbilde av appen som er befolket med noen enkle notater. 
+Under er det et skjermbilde av appen som er befolket med noen enkle notater og sjekklister. 
 
-![](/docs/release1/img/JavaFXinterface.png)
+![](/docs/release3/img/MainScreen.png)
 
 ## Struktur
 

script/springboot/README.md

@@ -6,4 +6,4 @@ Backenden til systemet er laget med Spring Boot. `ApiService`-klassen initialise
 
 Se [API.md](/docs/release3/API.md) for mer informasjon.
 
-I tillegg benytter backenden seg av `data`-modulen til å lese/skrive data. I de fleste tilfeller ville man brukt en database, men valgte denne metoden siden oppgaven spurte eksplisitt om å lagre i json.
+I tillegg benytter backenden seg av `data`-modulen til å lese/skrive data. I de fleste tilfeller ville man brukt en database, men valgte denne metoden siden oppgaven spurte eksplisitt om å lagre i json.