Project gitflow

[lobisquit]

Given this project is a group one, we must agree on the way to actually use git (this is called sometimes gitflow).

My proposal is to keep master branch as clean as possible, committing there only changes that are approved by the most of us.
To allow this, I would suggest the use of branches as pull request: I will explain in detail below.
(if you have no clue what I'm talking about, see here or ask below 😉)

1. When you want to push upstream some work (either new sections or modifications about existing pieces), you should commit them to a new branch, with a significant name (ex. modify_main_file). This allows separation from old and reviewed work with new one.

    git checkout -b new_argument

    # ... modifications to project files ...
    git add .
    git commit -m "Added fancy wordart"

    git add .
    git commit -m "Added serious stuff"
    # iterate until your contribution (in this case new argument) is concluded

    git push --set-upstream origin new_argument

2. After having pushed them online, next step is to propose them for inclusion in master branch: this is done opening a pull request, see Asymptotic MC behaviour #1 for reference. This allows the others to review the new proposal work, adding comments and / or modifications (in the form of commits).
   See here GitHub procedure for creating one.

3. When everyone is happy with the work done, it is pulled in master branch, through Merge pull request button. I recommend to delete branches whose pull request has been accepted, to keep repository clean.

For any suggestion or proposal of modification, don't hesitate to reply below.

[lobisquit]

To enforce this policy, I have added additional protection setting to master branch: