okf: state that log.md is append-only history (SPEC 7)#188
Open
manumishra12 wants to merge 1 commit into
Open
Conversation
Section 7 describes log.md as a history of changes but did not say whether past entries may be edited. Adds a sentence: entries are append-only; producers SHOULD add new dated entries and record corrections as superseding entries rather than rewriting past ones. Additive and backward-compatible. Addresses GoogleCloudPlatform#89.
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
1 participant
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.
What
Section 7 describes
log.mdas a chronological history but does not say whether past entries may be edited or deleted. This adds a sentence making the intent explicit.Clarification
log.mdentries are append-only: producers SHOULD add new dated entries rather than editing or deleting past ones, so the log stays a faithful history.Additive and backward-compatible (SPEC section 11 minor-version rules).
Addresses #89.