Write board versions on boards and documentation?

BeeHive-org / BeeHive

BeeHive: a flexible open hardware platform for behavioural experiments

MIT License

10 stars 6 forks source link

Write board versions on boards and documentation? #21

Closed amchagas closed 3 years ago

amchagas commented 3 years ago

Since we are going through a few implementations of the boards, I think it would be useful to have this information printed on the boards, as this would help with knowing, when debugging and/or helping others implement the system, which board specifically we are discussing.

This would not be a lot of work I think, but would help prevent difficulties that come from people chatting about different board versions without knowing...

isobianin commented 3 years ago

Hi @amchagas , I completely agree on this one. However, I am not sure how to implement this straight away. Does it mean that each module will have its own version number? Or does it mean that the whole BeeHive system will have a version number which increments with each release? What number do we start with?

amchagas commented 3 years ago

That is a good question. here is a document I like for versioning software https://semver.org/ maybe we can use that as a base?

Something like 0.1.X for the current version, where the boards can have X in different numbers? or maybe this could be just confusing.
as we have all the boards as independent units (as in, I could have an arduino controlling the peltier board, if that was the only thing I had available), we could just number them independently? Then we could have a version number for BeeHive and clearly state somewhere that this version of BeeHive contains boards X,Y,Z in their respective versions 0.1,0.2 and 0.3?

isobianin commented 3 years ago

Hi @amchagas ,

I would go for the second option where each board has its own version and the start-up page/wiki home page will explicitly tell what is the current version of BeeHive and what corresponding versions of boards are included in that release.

I like the software versioning convention, should we mention it in the documentation?

isobianin commented 3 years ago

Hi @amchagas !

I have updated design on 5V3A breakout and implemented the new numeration convention. What do you think? It is simple as v0.1 here (fig.1).

Fig. 1 - 5V3A PCB

If it is alright, I think I could add it on every board

amchagas commented 3 years ago

Hi @isobianin ,

I think this looks good. Would add it to the other boards! Thanks!

isobianin commented 3 years ago

Hi @amchagas , agreed

amchagas commented 3 years ago

I think we can close this one?

isobianin commented 3 years ago

Hi, @amchagas, indeed