The project cleanup

[Quillion]

We need to clean up the files that get checked to git. Most likely some of the files are completely unnecessary (like workspace.xml and others). Also packages have to be reshuffled in a nicer way. In general project needs a cleanup. And I lack the insight to do it.

[Jovani]

I can take a look at this, but If I'm going to do so, going forward, I want ALL additions to code done through branches and pull requests. Including you, Edgar. I know it's your codebase but if we're gonna get in this together, there needs to be good management and code peer review.

My proposed steps are: Make a branch in the form of either bug- feature-

For example: feature-jumping bug-prevent_negative_gravity

Furthermore, when you push code, wait for someone to review it, and comment on it; and then merge it into master.

[Quillion]

I agree. Now the problem is that I am a noob when it comes to branches or anything of the kind. I have never done any branching. At both Evertz and my current job I am the sole master, so I need to learn this branch thing, and I would be very open to any tutorials or anything. Also negative gravity and jumping is a feature and works pretty well :-) I tested it. So basically then how this works is I branch the code, then I work on whatever it is, then I wait for review and then merge into master? Sounds pretty cool :-)

[Jovani]

Ok, I'll make this a guide for anyone else that's going to participate as well. Note, I'm assuming that you're on some form of Unix based machine. If you're not, you should be.

• To clone this repo to your local machine, do git clone git@github.com:Quillion/GameEngine.git

Pre-req: You are in the directory under master branch. (Or any other branch for that matter).

All < and > are there just for style purposes. Do not include those as part of your command.

• To list current branches, do git branch
• To create a branch, do git branch <branch_name>
• To delete a branch do git branch -d <branch_name> (Note, if it gives you an error and you want to force the delete, do -D)
• To switch branches do git checkout <branch_name>
  • Tip: You can quickly create and switch into a branch by doing git checkout -b <branch_name>
• If you wish to pull in someone else's work on a different branch, first create a local branch of the same name (as described above, then do git pull origin <branch_name>
• When done editing code, do git commit -am "<some meaningful commit message> To commit your code locally to a git commit. This is like a chapter of a book; generally speaking, each distinct task should be a commit.
• When you're done committing everything and wish to push to Github, do the following.
  • First, switch to master branch and pull in the latest changes by doing git pull origin master
  • Next, switch back into your branch, and do git merge master
  • There MAY be some conflicts. Resolve the conflicts and then do a commit.
  • When master is merged in and any conflicts are resolved, do git push origin <branch_name>
  • Now go over to Github, get into the codebase and switch to your branch using the UI. Click the Pull Request button and follow what the page says. You're doing a Pull Request from your branch to master.
  • Once the pull request is made, by default, all of us will be notified via email. If you want a quicker code review, text myself or anyone else. We will either give it an A-OK or comment on what needs be changed. When all is good, use the GitHub UI to merge the pull request into Master and then close the Pull Request. You may then optionally delete the branch, which I highly recommend you do if you don't see yourself using that branch name again relatively soon.

[haahmad]

http://git-scm.com/book Chapters 3-5

http://en.m.wikipedia.org/wiki/Integrator_workflow Master is blessed, don't merge breaking changes into it. Some sort of automated regression tests would help here.