Donkey Development Guide
Share
Explore

Github & Code Review Practices

General practices
Each feature should have is own branch.
Try to separate commits by subjects (for example: adding specific function, adding some styling for specific page or element and so on...).
Always fetch and pull origin before starting to work.
Naming branches
Each branch will start with a prefix following by a short description:
fix/ for fixing bugs
feature/ for adding a new feature
new-page/ for adding a new feature
new-template/ for adding a new template

2. The description part should be clear as possible.
// Bad description
fix/fixing-some issues

// Good Description
fix/fixing-home-hero-styles

2. The description should not be too long.
// Bad description
fix/fixing-home-hero-mobile-styles

// Good description
fix/fixing-home-hero-styles
Commits titles and descriptions
Each commit should have a clear title of what has been done in this commit.
// Bad Title
"fix some issues"

//Good Title
"fix FAQ arrow icon hover state"
3. If the commit is a complex one add some description to it also.

Share
 
Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.