sampsapursiainen / zeffiro_interface

Interface for using finite elements in inverse problems with complex domains
GNU General Public License v3.0
24 stars 15 forks source link

Stable release #129

Closed sampsapursiainen closed 1 year ago

sampsapursiainen commented 1 year ago

(Check the Milestones for the DLs)!

We would need to release a stable version where the recent contributions have been debugged and some example scripts for understanding the usage would be provided.

The parts to be checked include:

I would request that each contributor would (1) debug tools they have developed, (2) that the tools can be opened using zef_tool_start.m function, (3) check that those can be run both in graphical user interface mode and on command line in terminal (without the java interface or any graphics available), and (4) The scripts folder includes a self-supported demonstrator that (a) starts the interface, (b) imports or opens a project, (c) runs the tool with test data (numerical simulations if available, a small set can be uploaded in the repository, if needed and if it is ok to do so regaring any IPRs, alternatively an online dataset can be downloaded for the deployment run, if it is not applicable otherwise).

SeSodesa commented 1 year ago

Once the stable release is made, I would suggest bumping the version to 6.0.0, just because semantic versioning has not been properly followed thus far. From then on, the guidelines listed on https://semver.org/ should be followed:

Given a version number MAJOR.MINOR.PATCH, increment the:

  1. MAJOR version when you make [backwards] incompatible API changes,
  2. MINOR version when you add functionality in a backwards compatible manner,
  3. PATCH version when you make backwards compatible bug fixes

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

Possible followers of the project on MathWorks File Exchange probably expect proper semantic versioning to be followed, as MathWorks seems to require its use when projects are published and versions released.