Code

Katalog główny

W głównym katalogu repozytorium znajdują się ogólne dokumenty i pliki związane z repozytorium. Umieszczanie tutaj jakiegokolwiek kodu biznesowego nie jest wskazane. Normalnie w repozytoriach wystarczy trzymać kod w głównym katalogu, ale w naszym projekcie git używany jest również do przechowywania np. dokumentacji organizacyjnej, biznesowej, dlatego zdecydowaliśmy się rozdzielić te dwie części od siebie.

.github

Pliki zarządzające repozytorium na GitHubie, CI/CD, task automation.

workflows

Wszystko wykorzystywane przez GitHub Actions - pliki .yml opisujące dzialanie konkretnych tasków wykonywanych po jakiejś akcji w repo. Worflows opisane są szerzej na stronie Actions - CI/CD

WMIAdventure

Główny katalog przeznaczony na część programistyczną projektu. Znajdziemy tutaj podfoldery z poszczególnymi modułami systemu (frontend, backend) i pliki Dockera (Więcej o Dockerze w Budowanie i Uruchamianie)

docs

Folder z dokumentacją projektową. Przechowujemy tutaj dokumenty zwiazane z aspektem biznesowym projektu takie jak dokument wizji czy dokument wymagań projektowych.

Issues

Issues w organizacji projektu to po prostu zadania. Podzieliliśmy je na dwie główne kategorie:

• User Stories, czyli po prostu Agilowe User Storiesy wraz z przydzielonymi im Story Pointsami.
• Taski - najczęściej wchodzą w skład jednego lub wielu User Storiesów i reprezentują zadanie (najczęściej programistyncze).

Milestones to Agilowe Epici w których skład wchodzą przypisane im Issues.

Pull Requests

Każdy z członków zespołu przed mergowaniem do gałezi implementacyjnej danej funkcji systemu zakłada Pull Requesta i wyznacza osoby do Code Review. Staramy się dbać o jakość kodu, dlatego dbamy o to, aby każda jego część była dokładnie sprawdzana przez innych członków zespołu. Dokumentacja projektowa często wymaga udziału wielu osób, a Pull Requesty idealnie nadają się do sugerowania zmian.

Discussions

(Jeszcze nie zaimplementowane w schemacie pracy)

Actions

Obecnie korzystamy z GitHub actions do przeprowadzania CI/CD (Continuous Integration / Continuous Deployment) dla commitów i pull requestów. Więcej w sekcji CI/CD

Projects

Jeden projekt to w naszej metodyce jeden sprint.