Skip to content
This repository was archived by the owner on Jun 19, 2023. It is now read-only.

Commit 0061a00

Browse files
stevemaopetervanderdoes
authored andcommitted
Standarize the markdown a bit
Use shell for all code in the file
1 parent 58dd475 commit 0061a00

File tree

2 files changed

+51
-38
lines changed

2 files changed

+51
-38
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
[sirn]: https://github.com/sirn
3232
[zheeeng]: https://github.com/zheeeng
3333
[mayerc-MSFT]: https://github.com/mayerc-MSFT
34+
[stevemao]: https://github.com/stevemao
3435

3536
# Changelog
3637

@@ -52,6 +53,9 @@
5253
[mayerc][mayerc-MSFT]
5354
* Enhancement: Add option that will not allow the a merge back into the develop branch.
5455

56+
[Steve Mao][stevemao]
57+
* Fix: Standarize the README markdown.
58+
5559
#### 1.11.0
5660
[Peter van der Does][petervanderdoes]
5761
* Bugfix: Problems when using fetch.prune

README.md

Lines changed: 47 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ See the Wiki for up-to-date [Installation Instructions](https://github.com/peter
2929

3030
## Integration with your shell
3131

32-
For those who use the [Bash](http://www.gnu.org/software/bash/) or [ZSH](http://www.zsh.org)
33-
shell, you can use my [fork of git-flow-completion](https://github.com/petervanderdoes/git-flow-completion)
34-
which includes several additions for git-flow (AVH Edition), or you can use the
35-
original [git-flow-completion](http://github.com/bobthecow/git-flow-completion)
36-
project by [bobthecow](http://github.com/bobthecow). Both offer tab-completion
37-
for git-flow subcommands and branch names with my fork including tab-completion
32+
For those who use the [Bash](http://www.gnu.org/software/bash/) or [ZSH](http://www.zsh.org)
33+
shell, you can use my [fork of git-flow-completion](https://github.com/petervanderdoes/git-flow-completion)
34+
which includes several additions for git-flow (AVH Edition), or you can use the
35+
original [git-flow-completion](http://github.com/bobthecow/git-flow-completion)
36+
project by [bobthecow](http://github.com/bobthecow). Both offer tab-completion
37+
for git-flow subcommands and branch names with my fork including tab-completion
3838
for the commands not found in the original git-flow.
3939

4040

@@ -45,7 +45,7 @@ of the project Wiki.
4545
* Version Numbering Scheme.
4646
Starting with version 1.0, the project uses the following scheme:
4747
\<MAJOR\>.\<MINOR\>.\<REVISION\>\
48-
* AVH is the acronym of "A VirtualHome"
48+
* AVH is the acronym of "A VirtualHome"
4949

5050
## Please help out
5151

@@ -54,7 +54,7 @@ welcome and I encourage you to use the [Issues
5454
list](http://github.com/petervanderdoes/gitflow-avh/issues) on Github to provide that
5555
feedback.
5656

57-
Feel free to fork this repository and to commit your additions. For a list of
57+
Feel free to fork this repository and to commit your additions. For a list of
5858
all contributors, please see the [AUTHORS](AUTHORS) file.
5959

6060
Any questions, tips, or general discussion can be posted to the Google group:
@@ -73,8 +73,8 @@ git clone -b master git@github.com:<username>/gitflow-avh.git
7373
cd gitflow-avh
7474
```
7575

76-
The `-b master` switch has to be added since the fork operation automatically
77-
clones the `develop` branch of the official gitflow repository and cloning it
76+
The `-b master` switch has to be added since the fork operation automatically
77+
clones the `develop` branch of the official gitflow repository and cloning it
7878
results in a local repository with just a `develop` branch.
7979

8080
If you do not have gitflow installed yet install it by running `make && make install`.
@@ -124,45 +124,50 @@ The ``-d`` flag will accept all defaults.
124124

125125
* To list/start/finish/delete feature branches, use:
126126

127-
128-
git flow feature
129-
git flow feature start <name> [<base>]
130-
git flow feature finish <name>
131-
git flow feature delete <name>
127+
```shell
128+
git flow feature
129+
git flow feature start <name> [<base>]
130+
git flow feature finish <name>
131+
git flow feature delete <name>
132+
```
132133

133134
For feature branches, the `<base>` arg must be a branch, when omitted it defaults to the develop branch.
134135

135136
* To push/pull a feature branch to the remote repository, use:
136137

137-
138-
git flow feature publish <name>
139-
git flow feature track <name>
138+
```shell
139+
git flow feature publish <name>
140+
git flow feature track <name>
141+
```
140142

141143
* To list/start/finish/delete release branches, use:
142144

143-
144-
git flow release
145-
git flow release start <release> [<base>]
146-
git flow release finish <release>
147-
git flow release delete <release>
145+
```shell
146+
git flow release
147+
git flow release start <release> [<base>]
148+
git flow release finish <release>
149+
git flow release delete <release>
150+
```
148151

149152
For release branches, the `<base>` arg must be a branch, when omitted it defaults to the develop branch.
150153

151154
* To list/start/finish/delete hotfix branches, use:
152155

153-
154-
git flow hotfix
155-
git flow hotfix start <release> [<base>]
156-
git flow hotfix finish <release>
157-
git flow hotfix delete <release>
156+
```shell
157+
git flow hotfix
158+
git flow hotfix start <release> [<base>]
159+
git flow hotfix finish <release>
160+
git flow hotfix delete <release>
161+
```
158162

159163
For hotfix branches, the `<base>` arg must be a branch, when omitted it defaults to the production branch.
160164

161165
* To list/start support branches, use:
162166

163-
164-
git flow support
165-
git flow support start <release> <base>
167+
```shell
168+
git flow support
169+
git flow support start <release> <base>
170+
```
166171

167172
For support branches, the `<base>` arg must be a branch, when omitted it defaults to the production branch.
168173

@@ -171,22 +176,26 @@ The ``-d`` flag will accept all defaults.
171176
You can easily publish a feature you are working on. The reason can be to allow other programmers to work on it or to access it from another machine. The publish/track feature of gitflow simplify the creation of a remote branch and its tracking.
172177

173178
When you want to publish a feature just use:
174-
175-
git flow feature publish <name>
179+
```shell
180+
git flow feature publish <name>
181+
```
176182

177183
or, if you already are into the `feature/<name>` branch, just issue:
178-
179-
git flow feature publish
184+
```shell
185+
git flow feature publish
186+
```
180187

181188
Now if you execute `git branch -avv` you will see that your branch `feature/<name>` tracks `[origin/feature/<name>]`. To track the same remote branch in another clone of the same repository use:
182-
183-
git flow feature track <name>
189+
```shell
190+
git flow feature track <name>
191+
```
184192

185193
This will create a local feature `feature/<name>` that tracks the same remote branch as the original one, that is `origin/feature/<name>`.
186194

187195
When one developer (depending on your work flow) finishes working on the feature he or she can issue `git flow feature finish <name>` and this will automatically delete the remote branch. All other developers shall then run:
188-
196+
```shell
189197
git flow feature delete <name>
198+
```
190199

191200
to get rid of the local feature that tracks a remote branch that no more exist.
192201

0 commit comments

Comments
 (0)