exercism / legacy-docs

Other
84 stars 55 forks source link

create exercise-versioning.md #31

Closed eclecticjohny closed 7 years ago

eclecticjohny commented 7 years ago

Move copy from https://github.com/exercism/x-common/blob/master/CONTRIBUTING.md#exercise-versioning to a separate file in https://github.com/exercism/docs/tree/master/maintaining-a-track

Fixes #25

eclecticjohny commented 7 years ago

It looks as though the x-common exercise can be versioned in the canonical-data.json file in the exercises directory, however, I am failing to to see how that version is linked to in a language specific exercise.

kytrinyx commented 7 years ago

Thank you @eclecticjohny! 🌷

What I'm missing in this document is a link to how an exercise's track version can be linked to the x-common exercise version.

I don't know if we ever decided how to do that. Track versioning predates exercise versioning.

My suggestion would be to specify that the versions are unrelated, and to increment track versions only if the test suite introduces a breaking change.

ErikSchierboom commented 7 years ago

That's fine, I was thinking about test generators. For test generators, you can and probably should link to the x-common version used to generate the tests.

eclecticjohny commented 7 years ago

This section of the documentation is unclear for me and it looks as though some things need to be ironed out with the versioning. I am sorry but I am unable to complete this request as it is stated at this time. I will try and help the project in another way in the future. Thanks.

kytrinyx commented 7 years ago

No, @eclecticjohny, we can merge this as is and update the documentation later. It's useful to have this conversation to figure out if we had to do some updating to the file up front. That's part of the process.