Skip to content

docs(adr): ADR 007 — stable finding fingerprint schema#160

Merged
Krishan27 merged 1 commit into
mainfrom
docs/adr-007-stable-fingerprints
Jun 23, 2026
Merged

docs(adr): ADR 007 — stable finding fingerprint schema#160
Krishan27 merged 1 commit into
mainfrom
docs/adr-007-stable-fingerprints

Conversation

@Krishan27

@Krishan27 Krishan27 commented Jun 23, 2026

Copy link
Copy Markdown
Collaborator

Defines the v1.0 fingerprint schema: provider:callType:flagKey:normalizedFilePath. Foundation for baseline mode and SARIF stability. Part of the v1.0.0 milestone (#141).

Summary by CodeRabbit

  • Documentation
    • Added architectural documentation defining stable finding fingerprints schema for FlagLint v1.0, including fingerprint composition, file path normalization rules, and implementation guidelines.

Defines provider:callType:flagKey:normalizedFilePath as the v1.0 fingerprint
schema. Foundation for baseline mode (ADR 008) and SARIF stability.
Part of the v1.0.0 milestone.

Signed-off-by: Krishan Kant Sharma <krishansharma0327@gmail.com>
@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 70ed72c5-f8c1-4529-8a21-d92f763ffbc2

📥 Commits

Reviewing files that changed from the base of the PR and between db3923e and 76485f0.

📒 Files selected for processing (1)
  • docs/adr/007-stable-finding-fingerprints.md

📝 Walkthrough

Walkthrough

Adds docs/adr/007-stable-finding-fingerprints.md, a new accepted ADR defining the v1.0 fingerprint schema (provider:callType:flagKey:normalizedFilePath), file path normalization rules, dynamic-key sequential indexing, same-file collision and rename limitations, implementation steps for FlagUsage, and documented consequences.

Changes

ADR 007: Stable Finding Fingerprints

Layer / File(s) Summary
ADR 007 full document
docs/adr/007-stable-finding-fingerprints.md
New ADR with metadata and status (ACCEPTED), problem statement explaining why line numbers are fragile, the decision specifying the provider:callType:flagKey:normalizedFilePath schema with normalization rules and dynamic-key indexing, the implementation plan for adding fingerprint to FlagUsage and JSON output, and consequences including known collision and rename limitations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related issues

Possibly related PRs

  • flaglint/flaglint#136: ADR 004 (introduced in this PR) calls out designing "semantic fingerprints" for exception targeting, making it a direct architectural predecessor to the fingerprint schema defined in ADR 007.

Poem

🐰 A fingerprint carved from provider and key,
No more fragile line numbers — stability's free!
Normalize the path, index each dynamic call,
Collisions are noted, rename warnings and all.
With ADR in hand, the baseline holds tight —
This rabbit hops forward, the schema is right! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title clearly and specifically summarizes the main change: adding ADR 007 documentation for the stable finding fingerprint schema.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/adr-007-stable-fingerprints

Comment @coderabbitai help to get the list of available commands.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying flaglint with  Cloudflare Pages  Cloudflare Pages

Latest commit: 76485f0
Status: ✅  Deploy successful!
Preview URL: https://eae6fb99.flaglint.pages.dev
Branch Preview URL: https://docs-adr-007-stable-fingerpr.flaglint.pages.dev

View logs

@Krishan27 Krishan27 merged commit ff40b6c into main Jun 23, 2026
13 checks passed
@Krishan27 Krishan27 deleted the docs/adr-007-stable-fingerprints branch June 23, 2026 03:34
@Krishan27 Krishan27 restored the docs/adr-007-stable-fingerprints branch June 23, 2026 03:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant