diff --git a/README.md b/README.md index 59cb08296..46f495315 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,17 @@ You can also test a built version of MeshLab generated by the last commit pushed We provide a set of scripts that build and deploy MeshLab automatically. All the scripts can be found in the [scripts](https://github.com/cnr-isti-vclab/meshlab/tree/master/scripts) folder. For specific build instructions see the [src](https://github.com/cnr-isti-vclab/meshlab/blob/master/src/README.md) folder. +# Branches + +On this repository, we keep two relevant branches: + +- `main`: we keep here the **last release version of MeshLab**, with just bugfixes. In case of bugs caught after a release, this branch is used to publish "post-releases". +- `devel`: we add here new features and functionalities of the software that are going to appear in the next release of MeshLab. Bugfixes pushed in `main` are automatically merged on the `devel` branch. + +Before committing a new change, or sending a pull request, please choose the branch that better suits for your change. +If it is just a bugfix, or an edit that does not modify the software (e.g. documentation typos, changes to the deploy system, ...), use the `main` branch. +If it is a new feature that will change the behaviour or the usage of the software, use the `devel` branch. + # Structure of the Repository The MeshLab repository is organized as follows: