Difference between revisions of "Development Process"
(→Developing New Features: Clarify that bugs go to maint, include test merge to master in instructions, + some minor editorial changes.) |
(Clarify distinction between branches, remove old SVN-era backport instructions.) |
||
| Line 18: | Line 18: | ||
* ''master'' -- the main development branch | * ''master'' -- the main development branch | ||
| − | * '' | + | * ''maint'' -- the current release branch. |
| − | Developers may also have other branches in use for development or bugfixing. This is described later in this document. | + | Older release series are labeled with the release number, e.g. ''2.4''. Those branches are normally closed to new work shortly after a new ''maint'' branch is created from ''master'' at the beginning of a new release series. |
| + | |||
| + | Developers may also have other branches in use for development or bugfixing. This is described later in this document. These will generally '''not''' be pushed to the main repository. | ||
==Developing New Features== | ==Developing New Features== | ||
| Line 26: | Line 28: | ||
All new development work should target the ''master'' branch. This includes new features and enhancements. Small changes can be commited directly to ''master''. Larger features or architectural changes should happen on a feature-branch; once that feature is working it can get merged back into ''master''. | All new development work should target the ''master'' branch. This includes new features and enhancements. Small changes can be commited directly to ''master''. Larger features or architectural changes should happen on a feature-branch; once that feature is working it can get merged back into ''master''. | ||
| − | Bug fixes should be built against the ''maint'' branch. | + | Bug fixes should be built against the ''maint'' branch. See [[Fixing Bugs]] below for details. |
| − | |||
| − | |||
At any particular time, ''master'' should be "as stable as possible". We use feature branches to limit the risk that a feature never completes. If development of a feature were done solely in ''master'' and that feature never got completed it could leave ''master'' in a state where it doesn't compile, or it fails the regression tests. | At any particular time, ''master'' should be "as stable as possible". We use feature branches to limit the risk that a feature never completes. If development of a feature were done solely in ''master'' and that feature never got completed it could leave ''master'' in a state where it doesn't compile, or it fails the regression tests. | ||
| Line 52: | Line 52: | ||
==Fixing Bugs== | ==Fixing Bugs== | ||
| − | + | Bug fixes are generally merged into the ''maint'' branch. | |
| − | + | Since we frequently merge the ''maint'' branch into ''master'', please do a test merge of ''maint'' into ''master'' in your local repository to ensure that your patch merges cleanly. | |
| − | + | If it doesn't and you don't know what to do about it, say so on the bug report when you attach your patch so that a developer can help you asses the situation and decide how to resolve it. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Bugfix Branches=== | ===Bugfix Branches=== | ||
| Line 70: | Line 63: | ||
If the code has diverged enough that a simple bugfix can't be applied, or the bugfix is sufficiently complicated, then that bugfix warrants a bugfix branch. The developer can create a branch off the release branch to work on the bugfix, and once that's been tested that branch can be merged back into the release branch. Note that the bug should STILL be fixed in ''master'' first. | If the code has diverged enough that a simple bugfix can't be applied, or the bugfix is sufficiently complicated, then that bugfix warrants a bugfix branch. The developer can create a branch off the release branch to work on the bugfix, and once that's been tested that branch can be merged back into the release branch. Note that the bug should STILL be fixed in ''master'' first. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Changes on the Build System== | ==Changes on the Build System== | ||
Revision as of 01:11, 7 August 2014
This page describes the development process for developing GnuCash code. It talks about how we use Git and in particular how we use branches to manage the GnuCash source code and release process.
Contents
Development Process Goals
The goal of this process is to limit the number of potential bugs that enter the stable release branch(es) due to changes made to the sources. We want to make sure that changes made to releases have been audited and vetted BEFORE they are commited to the release branches. At the same time we want to try to keep the main development branch as stable as practical.
In particular, we want to prevent "bad releases". Those are releases where a bugfix inadvertantly breaks other code.
Documentation
Documentation should start before coding ...
New or reworked features should also be documented as it turns out, some bugs are a problem of communication between user and developer. If you do not have the resources to do the documentation self, you should at least assign a bugzilla entry to the documentation team with the essential information.
Branches
Branches in Git are cheap, therefore we should use branches to our advantage. There are always two "interesting" branches in use:
- master -- the main development branch
- maint -- the current release branch.
Older release series are labeled with the release number, e.g. 2.4. Those branches are normally closed to new work shortly after a new maint branch is created from master at the beginning of a new release series.
Developers may also have other branches in use for development or bugfixing. This is described later in this document. These will generally not be pushed to the main repository.
Developing New Features
All new development work should target the master branch. This includes new features and enhancements. Small changes can be commited directly to master. Larger features or architectural changes should happen on a feature-branch; once that feature is working it can get merged back into master.
Bug fixes should be built against the maint branch. See Fixing Bugs below for details.
At any particular time, master should be "as stable as possible". We use feature branches to limit the risk that a feature never completes. If development of a feature were done solely in master and that feature never got completed it could leave master in a state where it doesn't compile, or it fails the regression tests.
If you are at all questioning whether to develop directly in master or in a branch, do it in a branch.
As a general rule, development branches should not be pushed back to the main repository. If one needs to publish a development branch, fork the Github repository to your personal account and publish the branch there. This carries a cost, though: Merging a private branch will put all of the changes into a single "merge commit" and that will be all of the history on the main repository. For major changes it is better to rebase a series of changes into master.
Minor Changes
Developers with the requisite privs may push minor changes directly to master or to maint as appropriate without a feature branch.
Major Changes
Use your judgement about whether your major change should be done directly on master/maint or whether you should use a feature branch. We trust you. Just remember, smaller changesets are easier to audit. When possible try to ensure that each commit can compile; that makes it much easier to bisect when tracking down a regression.
Backwards-Incompatible Schema Changes
To make the policy clearer, backwards-incompatible schema changes in an unstable release, e.g. 2.5, require a change to the previous stable release, e.g. 2.4, to provide a read facility for the new schema.
Often it is easier to add a new KVP which will be simply ignored by older versions than to change the schema. But then it would become harder to get the database normalized for the SQL backend.
Fixing Bugs
Bug fixes are generally merged into the maint branch.
Since we frequently merge the maint branch into master, please do a test merge of maint into master in your local repository to ensure that your patch merges cleanly.
If it doesn't and you don't know what to do about it, say so on the bug report when you attach your patch so that a developer can help you asses the situation and decide how to resolve it.
Bugfix Branches
Many times a bugfix is simple and the code has not diverged. In that case the bug can be fixed on master and the changeset can be merged (cherry picked) directly onto the release branch. This will happen more often than not early on in the development cycle because master and the release started the same. As time goes on it may happen less often depending on the actual change and how much the code has diverged.
If the code has diverged enough that a simple bugfix can't be applied, or the bugfix is sufficiently complicated, then that bugfix warrants a bugfix branch. The developer can create a branch off the release branch to work on the bugfix, and once that's been tested that branch can be merged back into the release branch. Note that the bug should STILL be fixed in master first.
Changes on the Build System
See Build System#Changes on the Build System.
Updating Translations
Translations are "special". Translation updates can be made directly into the po directory of the release branch.
