Merge pull request #58 from BME-MIT-IET/sopar-doc

Dokumentáció Adrián munkájához
BME-MIT-IET · May 22, 2024 · 30fa581 · 30fa581
2 parents 1e115b1 + 83a84bf
commit 30fa581
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/doc/sopar/MavenAndGithubActions.md b/doc/sopar/MavenAndGithubActions.md
@@ -0,0 +1,8 @@
+# Build rendszer és CI beüzemelése
+
+## Maven
+A projket kezdetben nem használt semmilyen build rendszert (kézzell kellett fordítani). Ezért készítettem hozzá egy pom.xml fájlt, illetve átstruktúráltam a fájlokat és csomagokat a maven konvencióknak megfelelően.
+
+## Github actions
+Létrehoztam egy github actions-t a projektnek, hogy a tesztek minden 'main' ágra érkező commit esetén lefussanak.
+
diff --git a/doc/sopar/Sonarcloud.md b/doc/sopar/Sonarcloud.md
@@ -0,0 +1,8 @@
+# Statikus analízis használata
+
+## Sonarcloud beüzemelése a projekthez.
+A CI futtassa a statikus analízis eszközt.
+
+## Sonarcloud által jelzett hibák javítása
+Az általam javított hiba a következő volt:
+Több osztályon fellül volt írva az equals() úgy, hogy a hashCode() nem, pedig javaban elvárt viselkedés, hogy ha két objektum egyenlő az equals() szerint, akkor a hashCode()-nak ugyanazt az eredményt kell adnia mindkét objektumon meghívva.