FAQ git workflow

[Davide Del Vento]

Folks,
since git can be confusing to newcomers, I'd like to ask what is the
recommended workflow to develop proteus and slipstream in GitHub. I
would recommend the following, but please approve it and provide
details, or suggest something completely different.

1) git clone https://github.com/BruceDLong/ProteusCore.git

2) do your local development as you see fit, for example as described
here: http://osteele.com/archives/2008/05/my-git-workflow
Should this be in your own branch? Related with the following question.

3) push your stuff on GitHub with git push
Should this be in BruceDLong/ProteusCore.git or should I create my own
GitHub clone in point one and push there?

4) tell you what I did, so that you can merge it back in the main
development line, if you like what you'll see.

Thanks,
Davide

[Bruce Long]

Here is what I suggest. Since we are dealing with only a handful of files and a few thousand lines of code we can keep the process simple and flexible. It is my expectation that most of the programming for this project will not be in C++ but in the form of Proteus models and that we will create a distributed system for managing those separate from git. In fact, I find it likely that once the project management tools are working that we will switch from a web-based source control system to a Slipstream based system.

Thus, for now at least, let's use 1) and 2) and 4). For 3) either create a branch for your own work and push to that or, if the test_build.py script passes and you are confident I will like the basic idea of your code, push directly to the main branch.

To summarize:

1) git clone https://github.com/BruceDLong/ProteusCore.git

2) do your local development as you see fit, for example as described
here: http://osteele.com/archives/2008/05/my-git-workflow

3) push your stuff on GitHub with git push. You can push to your own branch in the ProteusCore repo or, if the test_builds.py script passes you can push to the main branch.

4) tell Bruce and the group what you did, so that I can approve/merge it.

~Bruce

--
Give me immortality or give me death!