diff --git a/Contributing-to-Project%3A-Serenity.md b/Contributing-to-Project%3A-Serenity.md index c4563d6..e952b33 100644 --- a/Contributing-to-Project%3A-Serenity.md +++ b/Contributing-to-Project%3A-Serenity.md @@ -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: @@ -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: - * Feature - Format: feature/ +#### Feature + Format: feature/name *Features will be used for adding new gameplay mechanics, UI updates, major changes.* - * Bugfix - Format: bugfix/ +#### Bugfix + 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.* - * Hotfix - Format: hotfix/ +#### Hotfix + Format: hotfix/name *Hotfixes are for fixing issues that prevent features from functioning. For example, missing dependencies etc.* - * Task - Format: task/ +#### Task + Format: task/name *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: