Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding gitflow #11

Merged
merged 5 commits into from
Feb 17, 2021
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@

### Tools :nut_and_bolt:

- [Git](git-github/)
- [Git](git/github/)
- [Gitflow](git/gitflow/)
- [MySQL](mysql/)
- [Markdown](git-github/MARKDOWN.md)

Expand Down
23 changes: 23 additions & 0 deletions git/gitflow/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Gitflow workflow

This document covers some of the important concepts for Gitflow workflow and how to use Gitflow workflow in a project.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This document covers some of the important concepts for Gitflow workflow and how to use Gitflow workflow in a project.
This document includes important concepts of **Gitflow Workflow** and how we can start using it in our projects.


### Windows
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a placeholder for macOS as well?
Just add To be added, someone else can go and add it for macOS.

1. [Gitflow Installation and Setup Guide](/gitflow/WINDOWS.md)
## Official documentation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a new heading called Useful Commands and list down all the commands there is a separate file and reference it under this heading?
I saw the documentation has the basic commands but we can add commands like how to create a feature branch using the release branch as the base branch to single time?
Here are some cool examples.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Satendra-SR We can target this later. I have created an issue #14 for tracking this


1. [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)

## Books

`To be added.`

## Video Tutorials

1. [GIT: Git Flow Introduction](https://www.youtube.com/watch?v=xgo60yhetZk)

2. [GIT: Git Flow Feature Branch and Pushing to Github](https://www.youtube.com/watch?v=XbapC7nm49s&list=TLPQMDMwMTIwMjGtHAS9DfBiKg&index=2)

## Exercises

`To be added.`
25 changes: 25 additions & 0 deletions git/gitflow/WINDOWS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Installation

### Requirements

1. Git

### Installing Git

1. [Download Git](https://git-scm.com/download/win)
1. Run the installer.
1. Once installation is completed. Initialize Git in your project directory with command
```
git init
```

### Installing Gitflow

1. As Git for Windows 2.5.3 and above ships with git-flow (the AVH edition of it), Once git is initialized in the project directory, we can get started with git flow.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It sounds like I'm reading about Windows 2.5.3. Can we rephrase the sentence a bit?

Suggested change
1. As Git for Windows 2.5.3 and above ships with git-flow (the AVH edition of it), Once git is initialized in the project directory, we can get started with git flow.
1. For Windows, Git with 2.5.3 and above ships with git-flow (the AVH edition of it), so we don't explicitly need to install git-flow. Once git is initialized in the project directory, we can get started with git-flow.

1. Initialize Gitflow in your project directory with command
```
git flow init -d
```
-d is used to choose default setting for git flow.


File renamed without changes.
File renamed without changes.