Update 'Contributing to Project: Serenity'

master
MathDev 1 week ago
parent 73fcbf47e2
commit e121ec5242

@ -1,4 +1,5 @@
Contributing to Project: Serenity is pretty straightforward. In this guide, you'll be able to use either GitBash directly or SourceTree. ### Contributing to Project: Serenity is pretty straightforward.
In this guide, you'll be able to use either GitBash directly or SourceTree.
## Choose your workflow: ## Choose your workflow:
@ -23,20 +24,20 @@ Always create a new branch for your task or feature. **Never commit directly to
The Types of Branches we use are as follows: The Types of Branches we use are as follows:
* Feature #### Feature
Format: feature/<name> Format: feature/name
*Features will be used for adding new gameplay mechanics, UI updates, major changes.* *Features will be used for adding new gameplay mechanics, UI updates, major changes.*
* Bugfix #### Bugfix
Format: bugfix/<name> Format: bugfix/name
*Bugfixes will be used for fixing bugs that don't appear to be game/project breaking, and may not have been noticed early.* *Bugfixes will be used for fixing bugs that don't appear to be game/project breaking, and may not have been noticed early.*
* Hotfix #### Hotfix
Format: hotfix/<name> Format: hotfix/name
*Hotfixes are for fixing issues that prevent features from functioning. For example, missing dependencies etc.* *Hotfixes are for fixing issues that prevent features from functioning. For example, missing dependencies etc.*
* Task #### Task
Format: task/<name> Format: task/name
*Tasks are smaller updates. For example, adding a new static mesh, implementing an animation etc.* *Tasks are smaller updates. For example, adding a new static mesh, implementing an animation etc.*
When you're sure about the branch type, checkout the branch. As an example: When you're sure about the branch type, checkout the branch. As an example:

Loading…
Cancel
Save