document version id conventions

[pixelzoom]

From #560 (comment):

• TODO: Document this somewhere when it becomes reality.

Need to document version id, file/dir naming conventions, etc. after #560 has been closed.

[jonathanolson]

Somewhat pending on phetsims/perennial#69, but the current version parsing uses major.minor.maintenance[-test][-oneOff] where test is testType.testNumber (e.g. dev.1). Major/minor/maintenance/testNumber are 1+ digits, and testType/oneOff is anything without "-" or ".".

toString is basically:

var str = `${this.major}.${this.minor}.${this.maintenance}`;
if ( typeof this.testType === 'string' ) {
  str += `-${this.testType}.${this.testNumber}`;
}
if ( typeof this.oneOff === 'string' ) {
  str += `-${this.oneOff}`;
}

I'll be free to fully document conventions when it is fully solidified.

[ariel-phet]

labeling for dev meeting for a check in.

[pixelzoom]

1/18/18 dev meeting: @jonathanolson will handle doc.

[jonathanolson]

Documented in perennial's SimVersion. Is that location fine for the canonical documentation for how versioning works, or should that be moved to some .md file?

[jonathanolson]

@pixelzoom, can you comment on whether there should be any improvements to the documentation?

[pixelzoom]

Doc in SimVersion and #560 (comment) looks great.

Back to @jonathanolson in case there's anything else to do here. Feel free to close.

[jonathanolson]

Closing, thanks!