docs(adr): add Architecture Decision Records for v3.x structural changes#1614
Draft
jptosso wants to merge 1 commit into
Draft
docs(adr): add Architecture Decision Records for v3.x structural changes#1614jptosso wants to merge 1 commit into
jptosso wants to merge 1 commit into
Conversation
Introduce docs/adr/ with 54 MADR-3.0 records covering every structural PR merged between v3.0.0 (2023-05-31) and v3.7.0 (2026-04-06) plus two unreleased post-v3.7.0 changes on main. Bugfixes, dependency bumps, chore/doc/test-only PRs are excluded. Categories: Feature (17), Parity (23), Perf (10), Refactor (4). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Introduces
docs/adr/— 54 MADR-3.0 records documenting everystructural change landed across the v3.x release train, from v3.0.0
(2023-05-31) through v3.7.0 (2026-04-06) plus two unreleased post-v3.7.0
changes on
main.Each ADR links to its PR and any linked issue, lists deciders,
summarises the decision, and quotes the specific reviewer / author
comments that drove it — or explicitly notes "No substantive technical
discussion recorded" when the change merged without architectural
debate.
What's in scope
Structural PRs only — new directives, operators, actions,
transformations, variables, collections, subsystems, breaking API
changes, algorithmic performance shifts, and internal refactors that
change shape.
Not in scope: bugfixes, doc-only / CI / chore changes, Renovate &
Dependabot bumps.
Numbers at a glance
≈ 1 in 3 structural changes in v3.x is a Feature; the other 2 are
upkeep. Parity — mostly catching up to ModSecurity's documented
surface — dominates the upkeep share.
Silent architecture: 14 / 54 ADRs (26 %) shipped without substantive
on-GitHub technical discussion (only approvals and / or bot comments);
the PR body or out-of-band threads (OWASP Slack) were the decision
record. Those ADRs use the explicit "No substantive technical
discussion recorded" marker rather than inventing dialogue.
Per-release timeline (sketch)
weight (HTTPS audit log,
MatchedRule.Log()) lands in v3.0.3.variables / transformations. OCSF audit log and transaction
context.Contextare the standout Features.count: 18 ADRs, carrying the 12-month backlog between v3.3.3 and
v3.4.0. Syslog writer, rule observer callback,
WAFWithRules, JSONdepth limit, ANTLR4 parser behind a build tag.
WAF.Close(),@rxprefilter, transformation cache, Aho-Corasick →bitmap. Features are mostly APIs that enable the Perf work.
main— 100 % Perf so far.Format
ADRs follow MADR 3.0 with a mandatory
Technical Discussionsection.Every ADR contains:
exist),
"No substantive technical discussion recorded" marker,
See
docs/adr/0000-template.mdfor thecanonical form and
docs/adr/README.mdfor thefull chronological index with a
Cat.column (F / P / ⚡ / R) perentry.
Why draft
Opening as draft so the maintainer team can:
Feature-vs-Parity line),
non-structural PR,
Test plan
ls docs/adr/ | wc -l→ 56 (54 ADRs +0000-template.md+README.md).the linked PR / issue threads.
grep -L "https://github.com/corazawaf/coraza/pull/" docs/adr/[0-9]*.mdreturns empty.
grep -L "^## Technical Discussion" docs/adr/[0-9]*.mdreturnsempty.
explicit "No substantive technical discussion recorded" marker.