Development Process

In order to keep TFM development organised, the following policy is in place for branches on the TotalFreedomMod repository:

• The devel branch is the main development branch. It is not guaranteed to be stable, but the new functionality (since the latest release) should work without problems. No commits may be directly pushed to this branch. Pull requests are merged into this branch when they are accepted and working.

• The server branch is a temporary branch to reflect the latest changes on the TotalFreedom server, it will eventually have its functionality migrated to the devel branch.

• The pr/XXX branches indicate temporary pull request branches. They must be merged to the devel branch and deleted, after work is complete.

• Other branches are development branches. Other branches are used for the development of new features, bug squashing and other contributions. The source on other branches are guaranteed to:

  • Compile without compilation errors.
  • Show no errors at server start, unless the last commit on the branch is prefixed with [WIP].

• The tfmX.X-mcY.Y branches are old branches. They will eventually all be removed.

• The tfmXX branches are old branches. They will eventually all be removed.