Baudspeed,
Put all of your ideas together in full. We can add or remove later. One of my goals is to provide a centralized information center. I have a some code guidelines up for vote.
1) Code Writers are responsible for providing a Reference Sheet(s) for their code. With this guideline, the PPF2k4 team will provide a Reference Sheet Template in which Coders can use to document their functions, arrays, variables/types, and constants.
I understand that writting documentation is not fun, but, must be done to so that code's purpose and use can be referenced (just, imagine Blitz with out a command reference). I will personally take on the responsibility of putting together a Table of Contents for all Reference Sheets. Coders can submit their Reference Sheets and changes to me and I will build/update the Table of Contents.
1a) Changes. If changes are required, Coders must submit a new Reference Sheet w/ changes to replace the old. I will NOT take on the task of performing these changes directly to Reference Sheets.
2) Code pertaining to the project should be posted in the Blitz Code Archives. Its a Open Source Project for the Community and this is the ideal location for code IMHO. Coders have the option to place the code in the archives themselves or provide me the code to do so.
3) Code modules should be stored in a single Module.bb and provide a 'Start','Update' and 'Stop' Function of some sort for use in the Main.bb. These are the only functions that will be allowed in the Main.bb. Contants, Globals, and Arrays should be defined the associated Module.bb. If the modules must be loaded in a specific order or the module requires another, this requirement should be stated in the Reference Sheet.
4) Code Modules should be 100% blitz and not rely on DLL's.
Put all of your ideas together in full. We can add or remove later. One of my goals is to provide a centralized information center. I have a some code guidelines up for vote.
1) Code Writers are responsible for providing a Reference Sheet(s) for their code. With this guideline, the PPF2k4 team will provide a Reference Sheet Template in which Coders can use to document their functions, arrays, variables/types, and constants.
I understand that writting documentation is not fun, but, must be done to so that code's purpose and use can be referenced (just, imagine Blitz with out a command reference). I will personally take on the responsibility of putting together a Table of Contents for all Reference Sheets. Coders can submit their Reference Sheets and changes to me and I will build/update the Table of Contents.
1a) Changes. If changes are required, Coders must submit a new Reference Sheet w/ changes to replace the old. I will NOT take on the task of performing these changes directly to Reference Sheets.
2) Code pertaining to the project should be posted in the Blitz Code Archives. Its a Open Source Project for the Community and this is the ideal location for code IMHO. Coders have the option to place the code in the archives themselves or provide me the code to do so.
3) Code modules should be stored in a single Module.bb and provide a 'Start','Update' and 'Stop' Function of some sort for use in the Main.bb. These are the only functions that will be allowed in the Main.bb. Contants, Globals, and Arrays should be defined the associated Module.bb. If the modules must be loaded in a specific order or the module requires another, this requirement should be stated in the Reference Sheet.
4) Code Modules should be 100% blitz and not rely on DLL's.