Development Process

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

• The master branch always reflects the source code for the TFM version currently on the TotalFreedom server. Only tfmXX branches may be merged into this branch. When the version of TFM is updated on the server, the master branch must be updated accordingly. No commits may be made to this branch.

• The tfmX.X-mcY.Y branches are the main development branches. The X.X represent two numbers indicating the version of TFM residing on the branch. The Y.Y represent two numbers indicating the Minecraft version for which the TFM on this branch is designed.

  • Work as expected, with no bugs in initial testing, unless the latest commit is prefixed with [Bleeding].
  • Meet all requirements of Other branches.

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

• The pr/XXX branches indicate temporary pull request branches. They must be merged to the appropriate tfmXX 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 [Bleeding].