empiricaly / empirica

Open source project to tackle the problem of long development cycles required to produce software to conduct multi-participant and real-time human experiments online.
https://empirica.ly/
Apache License 2.0
43 stars 8 forks source link

A very kind suggestion to adjust Empirica versioning #531

Open kaglowka opened 3 months ago

kaglowka commented 3 months ago

Is there an existing issue for this?

What happened?

Hi! I'm just getting familiar with Empirica (and thank you for this incredibly helpful framework!), so I'm perhaps in no position to demand changes, but I found the current version mismatch confusing (1.x.x releases corresponding to what's called Empirica 2 in the documentation).

I understand it's not an easy thing to adjust it now (and could cause further confusion), but I thought I'd create an issue to:

Steps To Reproduce

Actually I was trying to run a game based on Empirica 1, and at first I couldn't understand where the transition between Empirica 1 and 2 happened if this repo contains mostly 1.x.x releases. The comment at release 1.0 clarified it for me: https://github.com/empiricaly/empirica/releases/tag/v1.0.0

Empirica Version

No response

What OS are you seeing the problem on?

No response

What browser are you seeing the problem on?

No response

Relevant log output

No response

Anything else?

No response

Code of Conduct

npaton commented 3 months ago

Thank you for your feedback. I agree it's confusing. I'm afraid a version change now would be equally as confusing. It would signal to some that a major and backward-incompatible change happened, while it didn't. I'm torn. I obviously should have skipped to 2.0.0 on the first release. Now, I don't know. If people have opinions either way, please share them here.

kaglowka commented 3 months ago

Sure, I fully agree there's no clean solution now.

The best idea I can think of now is to take the opportunity if any backwards-incompatible changes are in fact made and make a jump to version 3.