STYLE GUIDE

This is the style guide for programmers of the Grimwood project at the West Coast Institute of Training. It will cover all the necessary information to keep your documentation up to date and how to successfully comment and submit code to the stage 2 programmers.

Blog Posts:
This blog will be used to pass on information to you. Every week, we will create a weekly report on our shared project class (friday) and you will be expected to reply to this post with a comment in the following format:

Name - Current Feature Assignment - Date

List What you did:

-

-

List any problems you had:

-

-

Which files did you change:

-

-

Which files did you add:

-

-

Have you completed Your current task:

- (Yes/No)

------------------------------------------------------------

Code Changes:
Throughout this project you will hopefully be making a lot of scripting and C++ changes. In addition to listing what you changed (and submitting these files to the stage 2s) you should also comment your code in a uniform format.

The format that we will be using is simple:
//PUT YOUR FULL NAME HERE
Code changes
More code changes
I'm being optimistic about how much work you will do
//PUT YOUR FULL NAME HERE

This may seem tedious but it will be significantly easier to find out what you changed for both yourselves and us, and will reduce the workload for everyone. It will also make it easier for us to find out who is doing the least work ;)

Bug Reports:

If you find any bugs during your playtime in Grimwood, you should promptly shout across the room and inform us of these no doubt rare problems. Make sure these bugs are recreatable and worth fixing (I think we'll be ok if there is a prop missing or something unimportant) and we will make note of them. Try not to report the same bugs repeatedly by listening to your fellow stage 1's shouting.

We will list all of these bugs in a gigantic file and work through them whenever possible. We may also assign you to fix these bugs (so don't report anything too difficult!)