shimming-toolbox / shimming-toolbox-matlab

Code for performing real-time shimming using external MRI shim coils
GNU General Public License v3.0
16 stars 5 forks source link

Add CHANGES.md to the project, with automatic update for new releases #146

Open jcohenadad opened 4 years ago

jcohenadad commented 4 years ago

Context

A file CHANGES.md is common in software projects. It lists the notable changes for each new release.

However, such file requires high maintenance load, making sure we don't forget important features associated with a new release.

Proposed solution

Implement a script to create changelog automatically, as done in SCT project. In brief, this script:

If we adopt this strategy, we would need to: