Branching Policy: Difference between revisions

From OpenMW Wiki
Jump to navigation Jump to search
(Created page with "The main line of development is the master branch in the [https://github.com/zinnschlag/openmw primary repository]. Occasionally when we are working on two versions at the same t...")
 
No edit summary
Line 1: Line 1:
The main line of development is the master branch in the [https://github.com/zinnschlag/openmw primary repository]. Occasionally when we are working on two versions at the same time, there will also be a next branch, which represents the main line of development for the release after the upcoming one. In this case only bug-fixes and well-tested or non-disruptive changes will go into the master branch.
The main line of development is the master branch in the [https://github.com/zinnschlag/openmw primary repository]. The master branch always contains the latest, potentially unstable work.


Developers who want to work on a new feature or a bug-fix are requested to created a new topic branch based either on the master or the next branch. If there is a next branch, it usually should be chosen over the master branch. But when in doubt, please ask on the development forum.
When a version release is impending, a feature freeze happens, and a separate openmw-''x'' (where ''x'' is the version number) branch is created. Only bugfixes and well-tested or non-disruptive changes are accepted into that branch.
 
Developers who want to work on a new feature or a bug-fix are requested to created a new topic branch based either on the master or the openmw-''x'' branch. Usually the master branch should be chosen over the openmw-''x'' branch. But when in doubt, please ask on the development forum.


The topic branch shall be given a short, descriptive, all-lowercase name.
The topic branch shall be given a short, descriptive, all-lowercase name.


Additional topic branches should branch of from master/next, unless they depend on another topic branch.
Additional topic branches should branch off from the master / openmw-''x'' branch, unless they depend on another topic branch.


Once a topic branch is ready, the developer should issue a pull request on github into the master/next branch of the primary repository. If you are unsure if the branch is ready, ask on the forum first.
Once a topic branch is ready, the developer should issue a pull request on github into the target branch of the primary repository. If you are unsure if the branch is ready, ask on the forum first.

Revision as of 05:14, 27 April 2013

The main line of development is the master branch in the primary repository. The master branch always contains the latest, potentially unstable work.

When a version release is impending, a feature freeze happens, and a separate openmw-x (where x is the version number) branch is created. Only bugfixes and well-tested or non-disruptive changes are accepted into that branch.

Developers who want to work on a new feature or a bug-fix are requested to created a new topic branch based either on the master or the openmw-x branch. Usually the master branch should be chosen over the openmw-x branch. But when in doubt, please ask on the development forum.

The topic branch shall be given a short, descriptive, all-lowercase name.

Additional topic branches should branch off from the master / openmw-x branch, unless they depend on another topic branch.

Once a topic branch is ready, the developer should issue a pull request on github into the target branch of the primary repository. If you are unsure if the branch is ready, ask on the forum first.