Versiebeheer Conventies

Programma's en Applicaties

• Github
• Sourcetree (windows gebruikers)
• Gitkraken (linux gebruikers)

Proces

Developers maken voor hun features "feature" branches aan. Dit doen zij in Sourcetree of Gitkraken. Elke User Story krijgt één feature branch. Op de branch wordt alléén aan de specifieke feature gewerkt waar die voor bedoelt is. Ook wordt er voor de feature een nieuw level aangemaakt in Unreal Engine, zodat merge conflicts worden voorkomen.

Artists maken aan het begin van het project voor zichzelf een "art" branch aan. Dit is waar ze gedurende het hele project hun werk op doen. Hier maken ze ook een eigen level in aan. Deze word niet meegenomen bij het mergen met develop.

Mergen

Voordat er een pull request wordt aangemaakt, moet er eerst worden getest op een Android apparaat. Dit betekent dus dat er een Android build wordt gemaakt en op een apparaat wordt gezet. In dit document staat hoe er een Android build gemaakt moet worden.

Wanneer een feature af is, wordt er een pull request aangemaakt en kijken alle andere developers ernaar voor een code review (behalve in bijzondere gevallen zoals ziekte). Uitzonderingen worden toegepast in overleg met de andere developers. Er wordt gemerged door Menno Weerman. Als Menno niet beschikbaar is spreken de developers die er wel zijn af wat er zal gaan gebeuren.

De titel van een pull request is de naam van de feature die de developer heeft gemaakt. Beschrijving is optioneel maar wel handig voor de andere developers.

Bij het mergen van developer branches letten wij erop dat alle features nog goed werken, of de code conventies gevolgd zijn, dat de performance van een build op het gewenste platform nog goed is indien het een feature is die daar invloed op kan hebben en dat er geen merge conflicts zijn.

Bij het mergen van art branches letten wij erop dat er geen merge conflicts zijn en dat de persoonlijke levels niet naar develop gaan.

Na elke sprint wordt een playable version naar master gepusht en uitgebracht tussen de releases.

Naming Conventies

Feature branches: feature/developernaam/featurenaam

UI branches: UI/developernaam/UInaam

VFX branches: VFX/developernaam/VFXnaam

Hotfix branches: Hotfix/developernaam/Hotfixnaam

Art branches: Art/artistnaam

Folder Naming Conventies:

In Content hebben we een mapje genaamd OostQuest. Daarin hebben we mapjes voor de hoofdonderdelen, zoals "Blueprints", "Widgets", "Art" etc. Bij het "Art" mapje zal er een subfolder zijn voor elk persoon. Bij het "Blueprints" mapje zal er een subfolder aangemaakt worden voor elke feature.