Spec / open-values-agreement
Open Values Agreement v0.1
The record of what a group agreed: the question, who was there, each agreement with who does it, by when and what counts as done, and what is still open. The Work Party page makes it in the browser and can read it back to revise it.
- Files people or tools write
- Status: draft
- Version: 0.1
- Format name in the file:
open-values-agreement
Draft. It may still change before it is called stable. A file someone writes by hand or with a tool, and keeps.
Who writes it and who reads it
Written by Futurism Institute sites: sites/futurism-institute/public/js/work-party.js. Read by Futurism Institute sites: sites/futurism-institute/public/js/work-party.js.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Always "open-values-agreement". Tells a reader that this file is the record of what a group agreed. | always "open-values-agreement" |
version required | The version of the agreement format this file follows, 0.1. | string |
recorded required | The date the browser saved the file, YYYY-MM-DD. | string |
question | The question the group settled, such as "Do we buy a second ladder, or share the one we have?" | string |
present | Who was there, one name per item. First names are enough. | list of string |
agreed required | What the group agreed, one item per agreement. Rows with nothing in what are left out. | list of object |
open | What is still open, one item per line, including who disagreed and with what. | list of string |
led_by | Who led the conversation. Present only when filled in. | string |
led_by_hoped | What the person who led hoped for going in. Present only when filled in. | string |
decided_by | How the group decided: "everyone" (everyone agreed), "no-objection" (nobody objected), "most" (most agreed) or "one-person" (one person decided after hearing everyone). Present only when chosen. | string |
dissent_read_by_holders | True when everyone named in open has read how their disagreement is worded and agrees it is how they would put it. Present only when true. | boolean |
checked_by | Who checks that the agreements get done. Present only when filled in. | string |
revision | Present when the file revises an earlier one: what it revises and what changed, computed by the Work Party. | any |
A reader MUST ignore fields it does not know, so a file can carry more than this list and still be read. A writer MUST NOT change what a listed field means.
The schema
Its address is https://openvaluesstandard.org/schema/agreement-v0.1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/agreement.schema.json.
The key words MUST, MUST NOT, SHOULD, SHOULD NOT and MAY are used as described in RFC 2119 and RFC 8174 when, and only when, they appear in capitals.
Whether this format fits your app is your call. The spec says what a file MUST hold. Which formats you read and write, and what your app does with them, is yours to decide.