From a67aebc2ddb70d37c1187208775971bc94536d65 Mon Sep 17 00:00:00 2001 From: AdamWillden Date: Fri, 6 Sep 2013 13:51:39 +0100 Subject: [PATCH] README.md update: - TODO node object composition rules - Further clarification on variable naming convention scope - VPC modification commit comment rule --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c749237e..44b5d163 100644 --- a/README.md +++ b/README.md @@ -19,13 +19,14 @@ We will be using the branching model laid out here: http://nvie.com/posts/a-succ ## Code * Avoid making changes in the base Source engine files; always try to move those changes into a FF-specific source file that derives from the base class. +* __TODO__ Design some object composition rules to keep code where we you expect it to be (there was a lot of code in strange places). Not sure how to address this yet. ### Syntax #### Variable and Function Names * __TODO__ Decide on a naming convention -* Always make variable and function names as descriptive as possible (if 'i' stands for 'currentPlayerIndex' then use 'currentPlayerIndex') +* Always make variable and function names as descriptive as possible, this includes for-loop variables (e.g. if 'i' stands for 'currentPlayerIndex' then use 'currentPlayerIndex'). #### File Names and Directory Structure @@ -39,6 +40,8 @@ We will be using the branching model laid out here: http://nvie.com/posts/a-succ Solution and makefiles are no longer stored on the repo, they are generated using [VPC](https://developer.valvesoftware.com/wiki/Valve_Project_Creator). To add/remove files from the project, you must edit the __game/client/client_ff.vpc__ and/or __game/server/server_ff.vpc__ files and then execute __createallprojects(.bat)__ in the __src/__ directory. To remove a non-FF-specific file from the project (like HL2DM files), add exactly what you would to add the file (or copy the line from the .vpc that includes it), but put a - before "$File". +AS A RULE: If changes are made to the VPC files as part of a commit then the commit comment should start with "VPCMOD: " for easy spotting by developers to indicate they need to re-run the bats. + ## Documentation ### DOCUMENTATION.md