EBIvariation / vcf-validator

Validation suite for Variant Call Format (VCF) files, implemented using C++11
Apache License 2.0
129 stars 39 forks source link

Latest release is experimental? #194

Closed CholoTook closed 4 years ago

CholoTook commented 4 years ago

Hi, which release should I use? The latest release seems to be experimental, which I don't want. thx.

jmmut commented 4 years ago

Hi, I recommend using v0.9.2 anyway.

v0.9.2 is experimental but only for some new features of the assembly checker. They are explained in https://github.com/EBIvariation/vcf-validator/releases. The validator is the same, or slightly more updated compared to v0.9.1.

If you plan to use those features, the behaviour of them might change (improve) in the future. v0.9.1 doesn't have those features at all, so if you want to use them now, v0.9.2 is your only option.

If you don't plan to use those features then v0.9.2 is as stable as v0.9.1, or even more stable because v0.9.2 has some small improvements over v0.9.1.

Let me know if this is clear and I'll close the issue.

CholoTook commented 4 years ago

Thanks, that's clear, but the title isn't. Not sure if you could word it better. e.g.

Release v0.9.2, 16 August 2019

This release has some small improvements over v0.9.1.

It also includes some experimental features of the assembly checker, described below. Please note that these experimental features may change.

I know this seems trivial, but it does confuse people.

jmmut commented 4 years ago

Thanks for the feedback. It's hard to convey all the meaning and still be concise. I edited the release notes mentioning your concerns.

CholoTook commented 4 years ago

Thanks so much JM!

All the best,

On Tue, 5 Nov 2019 at 11:31, jmmut notifications@github.com wrote:

Thanks for the feedback. It's hard to convey all the meaning and still be concise. I edited the release notes mentioning your concerns.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/EBIvariation/vcf-validator/issues/194?email_source=notifications&email_token=ANKSZTT72VWH3TH3D7BPDTLQSFKPPA5CNFSM4JJA3HM2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEDCQWSY#issuecomment-549784395, or unsubscribe https://github.com/notifications/unsubscribe-auth/ANKSZTVCX444SZZZPTJLXVTQSFKPPANCNFSM4JJA3HMQ .