README.md in abak-flow-0.1.4 vs README.md in abak-flow-0.1.5
- old
+ new
@@ -1,8 +1,8 @@
Abak-flow
=========
-Нет, это не новая идеология ведения проекта, это всего лишь набор утилит которые помогают связать использование git-flow и github
+Нет, это не новая идеология ведения проекта, это всего лишь набор утилит которые помогают связать использование [git-flow](https://github.com/nvie/gitflow) и [github flow](http://scottchacon.com/2011/08/31/github-flow.html)
# Концепция
Идеология git-flow использует следующий набор веток:
* *master* - всегда пригодна для развертывания
@@ -27,19 +27,21 @@
$ git config --global alias.request '!request'
$ git config --global github.user AwesomeCoder
$ git config --global github.token 0123456789yourf0123456789token
$ git remote add upstream git://github.com/anonimus/example.git
+**Обратите внимание:** В данном контексте под **upstream** подразумевается адрес репозитория в который будут оформляться pull request. А репозиторием **origin** будет являться ваш форк
+
# С чего начать?
$ git request --help
# Примеры использования
### Самый простой способ начать новую задачу:
$ git checkout develop
- $ git request feature
+ $ git request feature 'TASK-001'
$ touch 'hello.txt' && echo 'Hello world!' > hello.txt
$ git commit -a -m 'Hello world commit'
$ git request publish
Теперь то же самое, только словами:
@@ -51,11 +53,11 @@
* Затем публикация вашей ветки на вашем форке (если таковая уже есть, то просто обновление), затем оформление pull request из этой ветки в соответствующую правилам ветку на upstream (в данном случае это будет ветка develop)
Для задач, которые должны быть выполнены в виде hotfix принцип тот же:
$ git checkout master
- $ git request hotfix
+ $ git request hotfix 'TASK-001'
$ …
$ git request publish
*На самом деле переключаться на master или develop в самом начале вовсе не обязательно, этот шаг был приведен для пущей ясности*
@@ -79,10 +81,10 @@
$ git co feature/TASK-001
$ git request done --local
### Маленькие хитрости
-Если сразу правильно именовать ветки, т.е ветку с задачей создавать с именем, такого формата TASK-001, то, в описание pull request автоматически вставится ссылка на задачу в jira
+Если сразу правильно именовать ветки, т.е ветку с задачей создавать с именем, такого формата TASK-001, то, в описание pull request автоматически вставится ссылка на задачу в jira, а в имя pull request сразу вставится название, состоящее из имени задачи, т.е TASK-001
### А помощь?
Многие команды имеют какие-то дополнительные опции. Но они нужны только в экзотических случаях. Но при любом раскладе подсказку и тонкий намек всегда можно получить воспользовавших такой командой:
$ git request done --help
\ No newline at end of file