Skip to content

Architecture Decision Records

This section contains Architecture Decision Records (ADRs) for the Guts project.

What is an ADR?

An Architecture Decision Record captures an important architectural decision made along with its context and consequences. ADRs help future contributors understand why certain decisions were made.

ADR Index

ADRTitleStatus
ADR-001Use Commonware for P2P and ConsensusAccepted
ADR-002Content-Addressed Storage for Git ObjectsAccepted
ADR-003Custom Git Smart HTTP ProtocolAccepted
ADR-004Collaboration Data ModelAccepted
ADR-005Permission and Access Control HierarchyAccepted
ADR-006REST API Design PrinciplesAccepted
ADR-007Modular Crate ArchitectureAccepted

ADR Template

When creating a new ADR, use this template:

markdown
# ADR-XXX: Title

## Status
Proposed | Accepted | Deprecated | Superseded

## Context
What is the issue we're seeing that motivates this decision?

## Decision
What is the change we're proposing/have decided?

## Consequences
What becomes easier or harder because of this change?

## Alternatives Considered
What other options were evaluated?

References

Released under the MIT License.