Gitflow - Groep1Games/Gobling GitHub Wiki

We gebruiken drie verschillende soorten branches

• main De laatste gemergde versie van het project
• feature/ Branches die gemaakt zijn voor userstories
• hotfix/ Branches voor kleine veranderingen, voornamelijk voor bug fixes

Commits worden altijd in het engels geschreven

Commit format: <type>[scope]: <subject>

Dev Voorbeeld: feature[TradeUI]: Updates the trade UI when currency changes

Art Voorbeeld: model[NPCMesh]: Adds the goblin customer model

Type: dit is de type verandering of toevoeging die je gamaakt hebt, kies er altijd eentje uit deze lijst:

Type	Description
feature	A new feature
fix	A bug fix
docs	Documentation only changes
style	Changes that do not affect the meaning of the code (white-space, formatting)
refactor	A code change that neither fixes a bug nor adds a feature
test	Adding missing tests or correcting existing ones
perf	A code change that improves performance
comment	A code change that only adds or changes comments
chore	any other changes
model	Adding or modifying 3D models
texture	Creating or updating textures
material	Adjusting materials shaders
shader	Adjusting shaders
animation	Adding or tweaking animations
rig	Setting up or modifying rigs
vfx	Implementing visual effects
ui	Designing or updating UI assets
lighting	Adjusting lighting setups
scene	Placing or modifying objects in the scene
concept	Adding or updating concept art

Scope: dit gaat over wat je hebt toegevoegd of veranderd, dit is eigenlijk bijna altijd ook de naam van je branch.

Subject: dit is de uitleg van wat je specfiek gedaan hebt. Dit moet altijd in de tegenwoordige tijd staan. Schrijf hier wat de commit doet, dus NIET wat JIJ hebt gedaan.

Zodra er een feature klaar is, wordt er een pull request voor gemaakt. De changes worden daarna nagekeken en gecheked door een willekeurig persoon. De branch mag alleen approved en gemerged naar main worden door een dev of art lead, die checkt op het laatst of alles volgens de conventies zijn en of er merge conlficts zijn.