-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add
gitflow.md
to explain organization
- Loading branch information
1 parent
6944260
commit df3dc95
Showing
1 changed file
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Gitflow | ||
|
||
We'll be using the gitflow organization for the repo. I'll describe a TLDR version, but provide links to documents that explain it in further detail. | ||
|
||
### Organization | ||
|
||
The branches listed below will be used for the project. | ||
|
||
* `master` - Contains "production ready" code. i.e. The code that gets pushed to NPM. | ||
* `develop` - Contains code that's currently in progress. This is the branch that should be targeted for PRs. | ||
* `feature/*` - Contains a `feature`. This should be the current work for a single feature/addition to the codebase. It should have a sensible name. Let's say I want to comment all of the code, the feature branch name would be something like `feature/comment-js-files`. | ||
* `release` - This is branched from `develop` when a release is ready and holds the code for a release. It will be used to test to make sure there are no bugs before it gets pushed to `master`. | ||
* `hotfix` - If there is a bug in `master`, a hotfix branch is created with the fix to be merged DIRECTLY into master and then will be merged back into `develop` so that the fix is present in future code. | ||
|
||
### Resources | ||
* [GitKraken](https://www.gitkraken.com/learn/git/git-flow) | ||
* [Atlassian](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) |