search

openvar / variantValidator

Public repository for VariantValidator project
GNU Affero General Public License v3.0
67 stars 21 forks source link

Change logs (release notes) #527

Open leicray opened 1 year ago

leicray commented 1 year ago

Is your feature request related to a problem? VariantValidator undergoes constant development, but changes and improvements are not formally documented in an easily accessible fashion for end users.

Describe the solution you'd like The VariantValidator home page provides links to its component parts but no "change log" is provided for these individual parts. Change logs ought to be provided for VariantValidator and vv_hgvs on GitHub and change logs for VVDb, VVTA and VVSeqRepo ought to be provided in the individual directories on the data server .

Peter-J-Freeman commented 1 year ago

They are I believe. When we make a major release. I don't have the man power to do this more often. We may need to look at the way git is used, but this is currently low priority until we have someone in place who has the time to do it

Peter-J-Freeman commented 1 year ago

https://github.com/openvar/variantValidator/releases/tag/v2.2.0 Change log for the last stable release is here

leicray commented 1 year ago

I am aware of this type of change log, but it's not easily understandable for the typical end user. I was thinking of something more like a plain text file that summarises any new features, updates and bug fixes.

As you say, low priority until we can recruit more staff.

ifokkema commented 1 year ago

I agree with both of you; it's important (LOVD also has a separate changelog that is less technical), but a lot of work. I go through all PRs when I make an official release to document all changes, but it can be time-consuming.

Peter-J-Freeman commented 1 year ago

On the next release (pending) I think I'll got through the auto generated log and annotate it and comment. Have a little time