CenterForDigitalHumanities / CenterForDigitalHumanities/TPEN-services

Collaboration Contract v1.0 Ratification for Services, Interfaces, and RERUM

Open
#512 3 comments 0 reactions 0 assignees View on GitHub
collaboration contract cross-repo governance
Dominant language
JavaScript
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

## Summary
Adopt and ratify the websocket collaboration and deferred-persistence contract for cross-repository implementation.

## Contract Source
- docs/collaboration/websocket-collaboration-contract.md

## Required Decisions
- Event envelope and versioning
- Operation schema and idempotency requirements
- Deferred flush trigger windows
- Conflict payload and reconciliation responsibilities
- Reliability guarantees and limits

## Exit Criteria
- Maintainers from TPEN-services, TPEN-interfaces, and RERUM confirm agreement
- Any deviations are tracked as follow-up issues
- Contract version marked approved for Phase 1 rollout

Contributor guide

Open the contributing guide

Research direction

Start by reading docs/collaboration/websocket-collaboration-contract.md and review the listed decisions for the event envelope, operation schema, deferred flush windows, conflict handling, and reliability limits. Done means maintainers from TPEN-services, TPEN-interfaces, and RERUM agree, deviations are tracked as follow-up issues, and the contract is marked approved for Phase 1 rollout.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
backend-api-design, distributed-systems, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.