Liking cljdoc? Tell your friends :D

Architecture Decision Records

This directory contains Architecture Decision Records (ADRs) documenting significant design decisions in clj-ebpf.

What is an ADR?

An Architecture Decision Record captures an important architectural decision made along with its context and consequences. ADRs help:

  • Document why decisions were made
  • Onboard new contributors
  • Revisit decisions when context changes
  • Maintain consistency across the project

ADR Index

ADRTitleStatus
0001Use Java Panama FFI for Syscall InterfaceAccepted
0002Domain Specific Language for BPF Instruction GenerationAccepted
0003BPF Map Operations DesignAccepted
0004Structured Error HandlingAccepted
0005Testing StrategyAccepted

ADR Status Values

  • Proposed: Under discussion
  • Accepted: Decision made and in effect
  • Deprecated: No longer applies but kept for history
  • Superseded: Replaced by a newer ADR

Creating a New ADR

  1. Copy the template below
  2. Number it sequentially (e.g., 0006-*.md)
  3. Fill in the sections
  4. Submit for review

Template

# ADR NNNN: Title

## Status

Proposed | Accepted | Deprecated | Superseded by [ADR NNNN](link)

## Context

What is the issue we're addressing? What forces are at play?

## Decision

What is the decision? What did we decide to do?

## Consequences

What are the positive and negative consequences of this decision?

References

Can you improve this documentation?Edit on GitHub

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close