.Modelica.UsersGuide.ReleaseNotes.VersionManagement

Information

Development branches

Further development and maintenance of the Modelica Standard Library is performed with two branches on the public GitHub repository of the Modelica Association.

Since version 4.0.0 the Modelica Standard Library uses semantic versioning following the convention:

MAJOR.MINOR.BUGFIX

This provides a mechanism for maintaining releases and bug-fixes in a well defined way and is inspired by (but not identical to) https://semver.org.

Main development branch

Name: "master"

This branch contains the actual development version, i.e., all bug-fixes and new features. New features must have been tested before including them. However, the exhaustive tests for a new version are (usually) not performed. This version is usually only be used by the developers of the Modelica Standard Library and is not utilized by Modelica users.

Maintenance branch

Name: "maint/4.0.x"

This branch contains the released Modelica Standard Library version (e.g., v4.0.0) where all bug-fixes since this release date are included (also consecutive BUGFIX versions 4.0.1, 4.0.2, etc., up to when a new MINOR or MAJOR release becomes available; i.e., there will not be any further BUGFIX versions (i.e., 4.0.x) of a previous release). These bug-fixes might not yet be tested with all test cases or with other Modelica libraries. The goal is that a vendor may take this version at any time for a new release of its software, in order to incorporate the latest bug fixes.

Contribution workflow

The general contribution workflow is usually as follows:

  1. Fork the repository to your account by using the Fork button of the GitHub repository site.
  2. Clone the forked repository to your computer. Make sure to checkout the maintenance branch if the bug fix is going to get merged to the maintenance branch.
  3. Create a new topic branch and give it a meaningful name, like, e.g., "issue2161-fix-formula".
  4. Do your code changes and commit them, one change per commit.
    Single commits can be copied to other branches.
    Multiple commits can be squashed into one, but splitting is difficult.
  5. Once you are done, push your topic branch to your forked repository.
  6. Go to the upstream https://github.com/modelica/ModelicaStandardLibrary.git repository and submit a Pull Request (PR).
  7. Update your branch with the requested changes. If necessary, merge the latest "master" branch into your topic branch and solve all merge conflicts in your topic branch.

There are some special guidelines for changes to the maintenance branch.

As a recommendation, a valid bug-fix to the maintenance branch may contain one or more of the following changes.


Generated at 2020-06-05T21:39:08Z by OpenModelica 1.16.0~dev-442-g2e5bc9f