Repository navigation
Document the contract versioning rule (increase on any change of result) - #97
Merged
Merged
Conversation
…ntly of applications The guidelines stated that contract versions are not increased until a stable application records contracts (DataLab 1.4). This tied the versioning of Sigima to the releases of an application, while Sigima is a reference of its own. The rule is now: the version of a contract is increased whenever a change of a computation function changes the result it returns, in the change itself, whatever the releases of the applications using Sigima. It is not increased when previously refused inputs are now accepted, when the change has no effect on the result, or when the change is entirely covered by a versioned rule of the execution context (whose version is increased instead); inputs previously accepted and now refused require an increase. Keeping version 1 from 1.3.0 to 1.4.0 is recorded as a one-off exception (contracts just published, not used yet) that does not apply to later changes. The rule, with a checklist, is documented in the contributing guidelines, in a new user guide page "Operation contracts and versions", in a 1.4 release note, in the instructions for AI agents (contracts section, corrected example, checklist for modifying a computation function) and in the docstrings of sigima.proc.contracts and computation_function, with French translations. Closes #96 Assisted-by: Claude Opus 5.5
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #96 (corrects the principle written by #95).