Torque Game EngineTorque Game Engine Documentation
Version 1.3.x

General Guidelines

Please read through these guidelines before making your patch:

  1. Read the Torque change list-

    Read the Torque changelist for recent updates. This file contains important information about what is happening with the source code. You're bug fix or new feature may have already been added or made obsolete by recent changes.

  2. Describe your changes-

    Describe in detail all the changes in your patch. Be as specific as possible. Please don't send descriptions such as "fixed bug in terrain". Be much more detailed.

    If you are submitting a bug fix, please describe the bug, the process involved in reproducing it, and of course your solution. If the bug has been discussed on the forums, please include a link to the relevent thread. If you are submitting a new feature, please be clear about what new functionality is being added.

    If your patch is OS specific, please say so.

  3. Keep patches small and focused-

    Changes should be separated into small logical patches. Don't submit patches with numerous changes and/or features.

    If your patch includes a new feature and bug fixes it should probably be split into one or more patches. If your patch includes a change to a common base class and a new class that takes advantage of the change, separate those into two patches, etc. If one patch depends on another, simply state so in your submissions.

    On the other hand, all files related to a single change must be submitted in a single patch. i.e. if a bug fix affects two files, don't submit each file as a separate patch.

  4. Include only the necessary files in the patch-

    The patch should not include CVS files, backup files, pictures of your pet, etc.

  5. Test your patch before sending it in-

    A good way to do this is to checkout a clean copy of the source from CVS, apply the patch to that code, then rebuild and test your changes. Patches that don't apply cleanly will be automatically rejected.

  6. Patch the HEAD revision

    Only patches to the HEAD revision of CVS will be accepted. Make sure your local copy of the SDK is up to date before building your patch. If your out of date with the HEAD, your patch may not apply correctly and patches that do not apply are automatically rejected.