search

OCFL / spec

The Oxford Common File Layout (OCFL) specifications and website
https://ocfl.io
55 stars 14 forks source link

Should we version validation_codes.md? #553

Closed zimeon closed 3 years ago

zimeon commented 3 years ago

I think when we created https://github.com/OCFL/spec/blob/main/validation/validation-codes.md we imagined consistency of error and warning codes between versions. I think we should certainly maintain this but I think we should version the validation codes file (perhaps move it into the spec directory) because:

  1. How do we add a new error code in draft or for a new version without creating confusion? E.g. https://github.com/OCFL/spec/pull/550
  2. Even if we maintain codes, we may change descriptions from version to version
awoods commented 3 years ago

Yes, moving the validation/ directory into draft/ as siblings of 'spec/' and 'implementation-notes/' would be helpful.

zimeon commented 3 years ago

Would it be better/simpler to have validation_codes.md in the spec directory instead?

awoods commented 3 years ago

As long as the validation_codes.md lives in "draft/", and subsequently "1.1/", "2.0/", etc... I am fine with locating it within "draft/spec/" or "draft/validation/".