open-research-protocol 0.3.0

package/spec/v1/packet.schema.json

@@ -0,0 +1,552 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://orp.dev/spec/v1/packet.schema.json",
+  "title": "ORP Packet v1",
+  "description": "Machine-readable ORP packet for collaboration and discovery workflows.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema_version",
+    "packet_id",
+    "kind",
+    "created_at_utc",
+    "protocol_boundary",
+    "repo",
+    "run",
+    "lifecycle",
+    "gates",
+    "summary",
+    "artifacts"
+  ],
+  "properties": {
+    "schema_version": {
+      "type": "string",
+      "const": "1.0.0"
+    },
+    "packet_id": {
+      "type": "string",
+      "pattern": "^[A-Za-z0-9._:-]+$"
+    },
+    "kind": {
+      "type": "string",
+      "enum": [
+        "pr",
+        "claim",
+        "verification",
+        "problem_scope",
+        "atom_pass"
+      ]
+    },
+    "created_at_utc": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "protocol_boundary": {
+      "$ref": "#/$defs/protocol_boundary"
+    },
+    "repo": {
+      "$ref": "#/$defs/repo"
+    },
+    "run": {
+      "$ref": "#/$defs/run"
+    },
+    "lifecycle": {
+      "$ref": "#/$defs/lifecycle"
+    },
+    "claim_context": {
+      "$ref": "#/$defs/claim_context"
+    },
+    "atomic_context": {
+      "$ref": "#/$defs/atomic_context"
+    },
+    "gates": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/gate_result"
+      }
+    },
+    "summary": {
+      "$ref": "#/$defs/summary"
+    },
+    "evidence_status": {
+      "$ref": "#/$defs/evidence_status"
+    },
+    "artifacts": {
+      "$ref": "#/$defs/artifacts"
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "kind": {
+            "enum": [
+              "pr",
+              "claim",
+              "verification"
+            ]
+          }
+        }
+      },
+      "then": {
+        "required": [
+          "claim_context"
+        ]
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "kind": {
+            "enum": [
+              "problem_scope",
+              "atom_pass"
+            ]
+          }
+        }
+      },
+      "then": {
+        "required": [
+          "atomic_context"
+        ]
+      }
+    }
+  ],
+  "$defs": {
+    "protocol_boundary": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "process_only",
+        "evidence_paths"
+      ],
+      "properties": {
+        "process_only": {
+          "type": "boolean",
+          "const": true
+        },
+        "evidence_paths": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "note": {
+          "type": "string"
+        }
+      }
+    },
+    "repo": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "root_path"
+      ],
+      "properties": {
+        "root_path": {
+          "type": "string"
+        },
+        "git": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "present",
+            "branch",
+            "commit"
+          ],
+          "properties": {
+            "present": {
+              "type": "boolean"
+            },
+            "remote": {
+              "type": "string"
+            },
+            "branch": {
+              "type": "string"
+            },
+            "commit": {
+              "type": "string"
+            }
+          }
+        }
+      }
+    },
+    "run": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "run_id",
+        "tool",
+        "started_at_utc",
+        "ended_at_utc"
+      ],
+      "properties": {
+        "run_id": {
+          "type": "string",
+          "pattern": "^[A-Za-z0-9._:-]+$"
+        },
+        "tool": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "name",
+            "version"
+          ],
+          "properties": {
+            "name": {
+              "type": "string"
+            },
+            "version": {
+              "type": "string"
+            }
+          }
+        },
+        "deterministic_input_hash": {
+          "type": "string"
+        },
+        "started_at_utc": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "ended_at_utc": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "duration_ms": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "lifecycle": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "workflow_state"
+      ],
+      "properties": {
+        "workflow_state": {
+          "type": "string",
+          "enum": [
+            "draft",
+            "ready",
+            "reviewed",
+            "accepted",
+            "blocked",
+            "retracted"
+          ]
+        },
+        "claim_level": {
+          "type": "string",
+          "enum": [
+            "Exact",
+            "Verified",
+            "Heuristic",
+            "Conjecture"
+          ]
+        },
+        "claim_status": {
+          "type": "string",
+          "enum": [
+            "Draft",
+            "In review",
+            "Verified",
+            "Blocked",
+            "Retracted"
+          ]
+        },
+        "atom_status": {
+          "type": "string",
+          "enum": [
+            "todo",
+            "in_progress",
+            "blocked",
+            "done"
+          ]
+        },
+        "state_note": {
+          "type": "string"
+        }
+      }
+    },
+    "claim_context": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "claim_id"
+      ],
+      "properties": {
+        "claim_id": {
+          "type": "string"
+        },
+        "canonical_artifacts": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "atomic_context": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "board_id",
+        "problem_id"
+      ],
+      "properties": {
+        "board_id": {
+          "type": "string"
+        },
+        "problem_id": {
+          "type": "string"
+        },
+        "ticket_id": {
+          "type": "string"
+        },
+        "gate_id": {
+          "type": "string"
+        },
+        "atom_id": {
+          "type": "string"
+        },
+        "dependencies": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "ready_queue_size": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "board_snapshot_path": {
+          "type": "string"
+        },
+        "starter_scaffold": {
+          "type": "boolean"
+        },
+        "starter_note": {
+          "type": "string"
+        },
+        "route_status": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "done",
+              "total",
+              "strict_done",
+              "strict_total"
+            ],
+            "properties": {
+              "done": {
+                "type": "integer",
+                "minimum": 0
+              },
+              "total": {
+                "type": "integer",
+                "minimum": 0
+              },
+              "strict_done": {
+                "type": "integer",
+                "minimum": 0
+              },
+              "strict_total": {
+                "type": "integer",
+                "minimum": 0
+              }
+            }
+          }
+        }
+      }
+    },
+    "gate_result": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "gate_id",
+        "phase",
+        "command",
+        "status",
+        "exit_code",
+        "duration_ms"
+      ],
+      "properties": {
+        "gate_id": {
+          "type": "string"
+        },
+        "phase": {
+          "type": "string",
+          "enum": [
+            "scope_lock",
+            "structure_kernel",
+            "quant_assembly",
+            "interface_lift",
+            "verification",
+            "custom"
+          ]
+        },
+        "command": {
+          "type": "string"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "pass",
+            "fail",
+            "error",
+            "skipped"
+          ]
+        },
+        "exit_code": {
+          "type": "integer"
+        },
+        "duration_ms": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "stdout_path": {
+          "type": "string"
+        },
+        "stderr_path": {
+          "type": "string"
+        },
+        "evidence_paths": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "evidence_status": {
+          "type": "string",
+          "enum": [
+            "process_only",
+            "starter_scaffold",
+            "starter_stub",
+            "evidence"
+          ]
+        },
+        "evidence_note": {
+          "type": "string"
+        }
+      }
+    },
+    "summary": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "overall_result",
+        "gates_passed",
+        "gates_failed",
+        "gates_total"
+      ],
+      "properties": {
+        "overall_result": {
+          "type": "string",
+          "enum": [
+            "PASS",
+            "FAIL",
+            "INCONCLUSIVE"
+          ]
+        },
+        "gates_passed": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "gates_failed": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "gates_total": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "note": {
+          "type": "string"
+        }
+      }
+    },
+    "evidence_status": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "overall",
+        "starter_scaffold",
+        "strongest_evidence_paths",
+        "notes"
+      ],
+      "properties": {
+        "overall": {
+          "type": "string"
+        },
+        "starter_scaffold": {
+          "type": "boolean"
+        },
+        "stub_gates": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "starter_scaffold_gates": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "evidence_gates": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "process_only_gates": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "strongest_evidence_paths": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "notes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "artifacts": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "packet_json_path",
+        "packet_md_path",
+        "artifact_root"
+      ],
+      "properties": {
+        "packet_json_path": {
+          "type": "string"
+        },
+        "packet_md_path": {
+          "type": "string"
+        },
+        "artifact_root": {
+          "type": "string"
+        },
+        "extra_paths": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}

package/spec/v1/profile-pack.schema.json

@@ -0,0 +1,95 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://orp.dev/spec/v1/profile-pack.schema.json",
+  "title": "ORP Profile Pack Metadata v1",
+  "description": "Metadata contract for downloadable ORP profile packs.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema_version",
+    "pack_id",
+    "name",
+    "version",
+    "description",
+    "templates"
+  ],
+  "properties": {
+    "schema_version": {
+      "type": "string",
+      "const": "1.0.0"
+    },
+    "pack_id": {
+      "type": "string",
+      "pattern": "^[a-z0-9][a-z0-9-]*$"
+    },
+    "name": {
+      "type": "string"
+    },
+    "version": {
+      "type": "string"
+    },
+    "description": {
+      "type": "string"
+    },
+    "orp_version_min": {
+      "type": "string"
+    },
+    "variables": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/$defs/variable"
+      }
+    },
+    "templates": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/$defs/template"
+      }
+    }
+  },
+  "$defs": {
+    "variable": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "description"
+      ],
+      "properties": {
+        "description": {
+          "type": "string"
+        },
+        "required": {
+          "type": "boolean"
+        },
+        "default": {
+          "type": "string"
+        }
+      }
+    },
+    "template": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "path",
+        "description"
+      ],
+      "properties": {
+        "path": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "output_hint": {
+          "type": "string"
+        },
+        "default_profiles": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}

package/templates/CLAIM.md

@@ -0,0 +1,33 @@
+# Claim
+
+## Title
+
+## Claim ID
+Example: `CLAIM-YYYYMMDD-<short-name>`
+
+## Claim Level
+Choose one: **Exact / Verified / Heuristic / Conjecture**
+
+## Statement (1–5 sentences)
+
+## Scope / Assumptions
+
+## Instrument (optional)
+- Instrument(s) used:
+- Instrument parameters explored (if any):
+
+## Canonical Artifacts (source of truth)
+List exact paths (code/data/paper/proof/logs). ORP docs are not evidence.
+
+## Verification Hook
+(Required for Exact/Verified; recommended for Heuristic/Conjecture.)
+- Command(s) to run:
+- Expected outputs:
+- Determinism notes (seeds, versions, environment):
+
+## Status
+Draft / In review / Verified / Blocked / Retracted
+> Status reflects workflow state; Claim Level reflects epistemic strength.
+
+## Next Hook
+What this enables next (one concrete step).

package/templates/FAILED_TOPIC.md

@@ -0,0 +1,19 @@
+# Failed Path Record
+
+> Note: This record documents a failure of an approach, not a person.
+
+## Topic
+
+## Summary (1–3 sentences)
+
+## What was attempted
+
+## Why it failed
+Be specific: counterexample, missing lemma, performance barrier, ambiguity, etc.
+
+## Evidence (canonical artifacts)
+Paths + any verification record that supports the failure.
+
+## What this rules out
+
+## What might still work (next hook)