docs(adr): ADR 008 — baseline mode for CI adoption#176
Merged
Conversation
Defines --write-baseline and --baseline/--fail-on-new behavior, baseline file format (version:1 JSON), and edge case behavior for file moves. Part of the v1.0.0 milestone. Signed-off-by: Krishan Kant Sharma <krishansharma0327@gmail.com>
📝 WalkthroughWalkthroughAdds ChangesADR 008: Baseline Mode
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related issues
Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (3)
docs/adr/008-baseline-mode.md (3)
137-148: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueAdd closing period to final list item.
The last item in the Negative / Trade-offs section appears to be missing a period at the end of line 148.
✏️ Proposed fix
- accumulate silently. Recommend adding baseline regeneration to sprint - definition-of-done. + accumulate silently. Recommend adding baseline regeneration to sprint + definition-of-done.(If line 148 ends prematurely, ensure it concludes with a period.)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/adr/008-baseline-mode.md` around lines 137 - 148, The last bullet point in the Negative / Trade-offs section starting with "**Baseline can go stale**" is missing a period at the end of the line. Locate the final item in that list and add a period after "definition-of-done" to maintain consistent punctuation with the other list items in the section.
37-39: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueAdd language identifier to fenced code block.
Markdown linting requires fenced code blocks to specify a language for proper syntax highlighting and rendering.
✏️ Proposed fix
-``` +```bash flaglint validate ./src --baseline flaglint-baseline.json --fail-on-new -``` +```🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/adr/008-baseline-mode.md` around lines 37 - 39, The fenced code block containing the flaglint validate command is missing a language identifier for proper markdown linting. Locate the code block that starts with triple backticks followed by the flaglint validate command and add "bash" as the language identifier to the opening fence. Change the opening fence from three backticks to three backticks followed by "bash" to enable proper syntax highlighting and satisfy markdown linting requirements.Source: Linters/SAST tools
28-30: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueAdd language identifier to fenced code block.
Markdown linting requires fenced code blocks to specify a language for proper syntax highlighting and rendering.
✏️ Proposed fix
-``` +```bash flaglint audit ./src --write-baseline flaglint-baseline.json -``` +```🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/adr/008-baseline-mode.md` around lines 28 - 30, The fenced code block containing the flaglint audit command is missing a language identifier, which is required for proper markdown linting and syntax highlighting. Locate the code block that contains "flaglint audit ./src --write-baseline flaglint-baseline.json" and add "bash" as the language specifier after the opening triple backticks (change the opening fence from ``` to ```bash) to properly identify the code block as a bash command.Source: Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/adr/008-baseline-mode.md`:
- Around line 137-148: The last bullet point in the Negative / Trade-offs
section starting with "**Baseline can go stale**" is missing a period at the end
of the line. Locate the final item in that list and add a period after
"definition-of-done" to maintain consistent punctuation with the other list
items in the section.
- Around line 37-39: The fenced code block containing the flaglint validate
command is missing a language identifier for proper markdown linting. Locate the
code block that starts with triple backticks followed by the flaglint validate
command and add "bash" as the language identifier to the opening fence. Change
the opening fence from three backticks to three backticks followed by "bash" to
enable proper syntax highlighting and satisfy markdown linting requirements.
- Around line 28-30: The fenced code block containing the flaglint audit command
is missing a language identifier, which is required for proper markdown linting
and syntax highlighting. Locate the code block that contains "flaglint audit
./src --write-baseline flaglint-baseline.json" and add "bash" as the language
specifier after the opening triple backticks (change the opening fence from ```
to ```bash) to properly identify the code block as a bash command.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 239aa342-da79-41c8-9953-fda313c0eee4
📒 Files selected for processing (1)
docs/adr/008-baseline-mode.md
Deploying flaglint with
|
| Latest commit: |
86744d5
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://c0989a7c.flaglint.pages.dev |
| Branch Preview URL: | https://docs-adr-008-baseline-mode.flaglint.pages.dev |
This was referenced Jun 23, 2026
5 tasks
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
1 participant
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.
Defines baseline mode: --write-baseline and --baseline/--fail-on-new. Includes file format spec, behavior table, file-move edge case, and exit codes. Part of the v1.0.0 milestone.
Summary by CodeRabbit
Release Notes