Skip to content

Observatory ProtocolOpen developmentProposals

Observatory Improvement Proposals

How a change to the protocol is proposed, reviewed, decided and implemented, in public.

Version
0.1.0-draft
Status
Draft specification
Specification
CC BY 4.0
Code
Apache-2.0
Steward
GCRI Canada
Source
obsp-0.1-foundation

From draft to implemented

Changes are proposed as Observatory Improvement Proposals. A proposal that changes a function updates the specification, the function register, the affected schemas and the conformance tests in the same change. (OBSP 0.1 §10)

DRAFTREVIEWLAST_CALLACCEPTEDIMPLEMENTED
The stages of an Observatory Improvement Proposal

Proposals in the repository

Where proposals live and how they are numbered. (Observatory Protocol, Observatory Improvement Proposals)

OIPTitleStatus
NoneNoneNone

Start from 0000-template.md. The process is in ../GOVERNANCE.md.

The proposal template

Every proposal states its problem, the change, its compatibility, its tests and its open questions. (Observatory Protocol, OIP-NNNN: Title)

FieldValue
StatusDRAFT
Affectsspecification sections, schemas, registers
Protocol versionobsp/0.x

Problem

What cannot be done or proved today, and for whom.

Change

The normative text, in MUST / SHOULD / MAY, and the contract changes.

Compatibility

Breaking or not, under GOVERNANCE.md (Versions). Migration for existing records.

Tests

The positive and negative fixtures added, and what each negative one proves.

Open questions

References

Sources cited on this page, in order of first citation. Addresses were last checked on the date shown.

  1. OBSP 0.1 §10: Versioning and change Observatory Protocol 0.1 (draft), CC BY 4.0.
  2. Observatory Protocol, Observatory Improvement Proposals: oips/README.md Observatory Protocol 0.1 (draft), CC BY 4.0.
  3. Observatory Protocol, OIP-NNNN: Title: oips/0000-template.md Observatory Protocol 0.1 (draft), CC BY 4.0.