Git best practices
- Dominant language
- JavaScript
- Stars
- 1
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
# Git workflow, best practices
## Branches
### At any one time, there will be four relevant branches:
- master
- develop
- feature-*
- fix-*
## master
The branch `master` is always considered stable. At any point in time, someone may clone master, and have a fully working project (albeit with potentially reduced functionality). This branch is to be pushed when updated.
No work is to _ever_ be done directly in `master`.
## develop
The branch `develop` is the branch where development takes place. At any point in time, someone may clone master, and begin adding new features/bug-fixes. When `develop` reaches a stable-like state, it is to be merged back into `master`. This branch is to be pushed when updated.
## feature-*
The branch `feature-*` (`feature-login`, `feature-logo`, `feature-bootstrap`, etc...) it the branch where _new_ feature creation takes place. This branch is to be created off of `develop`, and once the feature is done, merged back into `develop`.
This branch is typically kept locally, unless the feature is large enough.
## fix-*
The branch `fix-*` (`fix-sqlinjection`, `fix-segfaults`, `fix-xss`, etc...) is the branch where bug-fixes for features takes place. This branch is to be created off of `feature-*`, and when the bug is fixed, merged back into `feature-*`
This branch is typically kept locally, unless the bug is large enough.
## ASCII art
```
* origin
| \
| \
| |
| *
| | \
| | \
| | * feature-a
| | /
| | /
| *
| / |
| / |
* *
| | \
| | \
| | * feature-b
| | /
| | /
| * develop
| /
| /
* master
```
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.