What’s the plan for branches in the spec repository?
Three options I can think of:
-
Only maintain the 1.1 document/branch. Because the 1.1 additions are all clearly identified as such, the 1.1 document can still be used to learn how to implement a 1.0 standard interpreter. This would be my preference because it will be simplest. If we chose this option, then the official 1.0 document on inform-fiction.org should have a note added saying it is frozen, and pointing people to the 1.1 document.
-
Commit changes to the 1.0 branch and then merge the 1.0 branch into the 1.1 branch. This treats the two branches like two branches of a software project. As long as the 1.1 additions are in separate paragraphs (as they should generally be), merges from 1.0 to 1.1 should be clean and automatically resolved. This makes it easier for people submitting changes as they only need to make a pull request to the 1.0 branch. Someone else will then have to (frequently or periodically) merge the 1.0 branch into the 1.1 branch.
-
When an update applies to both 1.0 and 1.1 require separate PRs for both branches. This is the worst option as it is just unnecessary work.
I’d like an answer to this soonish, as I’d like to add the various Z-Machine tests to the repo. Ideally we want most future changes to also be accompanied by tests, either in Praxix or in stand alone files.