GUIDLINES FOR RELEASING REALITY FACTORY BUILDS

[QuestOfDreams]

Cummunity Releases of Reality Factory:

To keep things organized you have to follow these guidelines if you want to release a custom build of Reality Factory:

What you need to provide

1) Provide all necessary files to update from the latest official release (EXE, DLLs, GameEntityDataTypes.h etc.)

2) Provide documentation of new/changed features (html or txt format)

3) Provide source code changes as:
a) complete .h/.cpp files; add a description of the changes in the edit history at the top of each file;
mark changes with

Code: Select all

// changed AUTHOR MONTH/DAY/YEAR
// end change

e.g.

Code: Select all

// changed QD 03/25/07
// end change

or
b) a list of code changes, including name of source file and line numbers of changes (referring to the latest official source code release)

Put the files of 1) and 2) in a zip file, put the source code changes in a separate zip file

Naming Conventions

Naming conventions for releases:
Community releases should be named in the following way:
Reality Factory CR Month/Day/Year
e.g.
Reality Factory CR 03/25/07

In CCommonData.cpp around line 718 change

Code: Select all

ReportError("--- Reality Factory 0.75C          ---",	false);

to reflect the release version e.g.:

Code: Select all

ReportError("--- Reality Factory CR 03/25/07    ---",	false);

Naming conventions for zip files:
update & docs: RealityFactoryCR_MonthDayYear.zip
source code: RealityFactoryCRSource_MonthDayYear.zip
e.g.
RealityFactoryCR_032507.zip
RealityFactoryCRSource_032507.zip

How to inform the community

Start a new topic in the programming forum with the release name as its title.
Provide links to the zip files described above.
Provide any information about the release as you see fit (tips, tricks, potential bugs etc)

[jonas]

Thanks I was hoping we would have some rules to go by.

I have on question though. Say we have 2 or 3 different people editing the code and adding features at the same time. How could we merge them? If we don't somehow merge them we might have "Reality Factory CR 03/25/07" that has some extra scripting commands, then shortly "Reality Factory CR 03/26/07" that has multiplayer, and ect.. Do you know of any way we could merge them or is there someway we could keep organized enough that we wouldn't need to do that?

Thanks.

[AndyCR]

I would recommend some form of source control for that - something like CVS or even better SVN. You can get a free CVS repository, for instance, at http://www.freepository.com . It would automatically merge trivial changes, and warn/force you to fix any changes to the same code at the same time.