docs(git): Explain that git-flow will be used

Description

Abstract

Adds a paragraph in the README file about git-flow being used in this project.

Motivation

I love git-flow since I discovered this flow 8 years ago.

Rationale

I added a sentence that it will not be enforced for other casual developers.

Info

Hash

a0569ddeb4fb8b994f30dbfbc0b5038400ce5b4c

Date

2019-06-03 13:54:59 +0200

Parents
  • docs(git): Add git commits to documentation [0a048252]2019-06-03 13:54:59 +0200

Children
  • ci: Configuration for circle-ci [fcd2779c]2019-06-03 13:55:00 +0200

Branches
Tags

(No tags)

Changes

README.rst

Type

Modified

Stats

+2 -0

@@ -294,6 +294,8 @@ If you want to validate an other commit message than the last one, check `ci/che

 The commits are so important to me that they will be available in the "Internals" part of the documentation in a easily browsable way.

+Also, I'm a fan of `git-flow <https://nvie.com/posts/a-successful-git-branching-model/>`_ and it (the `avh edition <https://github.com/petervanderdoes/gitflow-avh>`_) will be used in this project, but adding the username in the branch name (easier to filter on if many users), so for example my own development branches will be prefixed by `features/twidi/`. (If branches from other people in pull requests do not follow this pattern, it will be done on my side)
+
 ''''''
 Coding
 ''''''