Skip to content

docs: coderabbit badge + markdown lints#125

Merged
tsinis merged 7 commits intomainfrom
docs/coderabbit-badge
Mar 14, 2026
Merged

docs: coderabbit badge + markdown lints#125
tsinis merged 7 commits intomainfrom
docs/coderabbit-badge

Conversation

@tsinis
Copy link
Copy Markdown
Owner

@tsinis tsinis commented Mar 14, 2026

Description

Migrated to Zed (from VS Code), added CodeRabbit.AI badge. Fixed a lot of MD files.

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 🛠️ Bug fix (non-breaking change which fixes an issue)
  • ❌ Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactor
  • ✅ Build configuration change
  • 🧪 Tests
  • 📝 Documentation
  • ⚙️ CI/CD or GitHub Workflow configuration change
  • 📦 Dependencies update

Summary by CodeRabbit

  • Documentation

    • Updated GitHub issue templates with improved header structure.
    • Enhanced code of conduct with broader prohibited conduct guidance.
    • Added caching strategy documentation for HTTP status codes.
    • Added CodeRabbit Pull Request Reviews badge to README.
  • Chores

    • Updated Dart SDK constraint to 3.11.1.
    • Refined GitHub configuration and ignore patterns.
    • Refactored editor tooling configurations.
  • Tests

    • Enhanced status code random selection test coverage.

tsinis added 4 commits March 11, 2026 21:40
- Verifies that StatusCode.random returns an int as well as StatusCode
and docs

- Update issue template headings from `####` to `##` and `###` for
  proper hierarchy
- Add markdown titles to pull request template and MCP prompt files
- Fix minor formatting inconsistencies in CHANGELOG.md and code of
  conduct
- Improve markdown structure consistency across documentation
- Replace VS Code tasks with Zed editor support (.vscode/ → .zed/)
- Add .vscode/ to .gitignore for local editor settings
- Update .pubignore to exclude Zed configuration instead of VS Code
- Bump Dart SDK minimum version from 3.11.0 to 3.11.1 in example
- Add CodeRabbit PR review badge to README
- Fix trailing newlines in configuration files
- Update CHANGELOG with new badge documentation
github-actions[bot]
github-actions bot previously approved these changes Mar 14, 2026
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 14, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 14, 2026

Warning

Rate limit exceeded

@tsinis has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 12 minutes and 57 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 06d93fb8-c283-454e-a475-df0be8d1cf6e

📥 Commits

Reviewing files that changed from the base of the PR and between a513145 and 4173e99.

📒 Files selected for processing (3)
  • .github/ISSUE_TEMPLATE/performance.md
  • .github/ISSUE_TEMPLATE/refactor.md
  • .zed/debug.json
📝 Walkthrough

Walkthrough

This PR standardizes issue template header formatting, migrates editor configuration from VSCode to Zed, updates project documentation and metadata, and adds test assertions for StatusCode.random functionality.

Changes

Cohort / File(s) Summary
Issue Template Header Standardization
.github/ISSUE_TEMPLATE/bug_report.md, build.md, chore.md, ci.md, documentation.md, feature_request.md, performance.md, refactor.md, style.md, test.md
Standardized markdown header levels: #### Description## Description and #### Requirements### Requirements across all templates. Minor content additions in select templates (bug_report.md and revert.md).
Editor Configuration Migration
.vscode/tasks.json, .zed/debug.json
Removed comprehensive VSCode task configuration (pub get, analyze, format, tests, coverage); added Zed debug configuration with two Dart launch profiles for example execution.
Git Configuration Updates
.gitignore, .pubignore
Added .vscode/ to .gitignore; replaced .vscode/ with .zed/ in .pubignore for IDE-specific exclusions.
Project Documentation
README.md, CHANGELOG.md, .github/code_of_conduct.md, .github/pull_request_template.md
Added CodeRabbit badge to README; minor CHANGELOG formatting; expanded code of conduct language to include "aggression toward or disparagement of classes of individuals"; added PR template header.
Package Configuration
pubspec.yaml, example/pubspec.yaml, .github/dependabot.yaml
Updated Dart SDK constraint from ^3.11.0 to ^3.11.1 in example; reformatted pubspec.yaml metadata (topics, screenshots); adjusted dependabot.yaml Pub ecosystem labels formatting.
MCP Prompts
extension/mcp/prompts/cache_strategy.md, extension/mcp/prompts/handle_response.md
Added new Cache Strategy section with RFC 7231 guidance, TTL mapping, and Dart code examples; added Handle Response header to existing prompt.
Test Updates
test/src/status_code_test.dart
Added assertion verifying StatusCode.random(from:) returns an int in addition to being a StatusCode.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested labels

enhancement

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description check ✅ Passed The description covers the main areas of change and includes the required type-of-change checklist, though it lacks detailed explanation of what was specifically fixed or why the changes were made.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title 'docs: coderabbit badge + markdown lints' accurately reflects the main changes in the PR: adding a CodeRabbit badge to README and standardizing Markdown formatting across multiple files.

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

📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

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

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 14, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.57%. Comparing base (fdffb78) to head (4173e99).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #125   +/-   ##
=======================================
  Coverage   99.57%   99.57%           
=======================================
  Files           3        3           
  Lines        1397     1397           
=======================================
  Hits         1391     1391           
  Misses          6        6           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitai coderabbitai bot added the enhancement New feature or request label Mar 14, 2026
@tsinis tsinis changed the title Docs/coderabbit badge docs: coderabbit badge + markdown lints Mar 14, 2026
@github-actions github-actions bot added the D-5 label Mar 14, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
extension/mcp/prompts/cache_strategy.md (2)

35-42: ⚠️ Potential issue | 🟠 Major

Ensure TTL behavior is deterministic for all cacheable codes.

Line 35–42 maps only part of the RFC cacheable set, but Line 46–47 instructs storing whenever isCacheable is true. For cacheable codes not mapped (e.g., 203/206/300/405/414), ttl can be null, which makes retention behavior backend-dependent and potentially too long.

Suggested patch
-   final ttl = rawStatusCode.toRegisteredStatusCode()?.whenConstOrNull(
-     okHttp200: Duration(minutes: 5),
-     noContentHttp204: Duration(minutes: 1),
-     notFoundHttp404: Duration(minutes: 10),
-     movedPermanentlyHttp301: Duration(days: 1),
-     goneHttp410: Duration(hours: 1),
-     notImplementedHttp501: Duration(hours: 6),
-   );
+   final ttl = rawStatusCode.toRegisteredStatusCode()?.whenConstOrNull(
+         okHttp200: Duration(minutes: 5),
+         nonAuthoritativeInformationHttp203: Duration(minutes: 2),
+         noContentHttp204: Duration(minutes: 1),
+         partialContentHttp206: Duration(minutes: 2),
+         multipleChoicesHttp300: Duration(minutes: 10),
+         movedPermanentlyHttp301: Duration(days: 1),
+         notFoundHttp404: Duration(minutes: 10),
+         methodNotAllowedHttp405: Duration(minutes: 30),
+         goneHttp410: Duration(hours: 1),
+         uriTooLongHttp414: Duration(minutes: 30),
+         notImplementedHttp501: Duration(hours: 6),
+       ) ??
+       const Duration(minutes: 5); // conservative fallback

Also applies to: 46-47, 52-53

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@extension/mcp/prompts/cache_strategy.md` around lines 35 - 42, The TTL
mapping for rawStatusCode via toRegisteredStatusCode()?.whenConstOrNull only
covers some cacheable status codes, so when isCacheable is true ttl can be null
and retention becomes backend-dependent; update the ttl computation (the code
that assigns ttl from toRegisteredStatusCode() / whenConstOrNull) to include all
RFC-defined cacheable status codes (e.g., 203, 206, 300, 405, 414, etc.) with
explicit Duration values and add a deterministic fallback Duration (or explicit
non-cache action) for any remaining registered codes so that downstream logic
that checks isCacheable and uses ttl always has a non-null, predictable TTL.
Ensure you modify the same ttl variable and related logic that relies on
isCacheable to use the new explicit mapping or fallback.

52-52: ⚠️ Potential issue | 🟡 Minor

Remove unverified performance claim from the prompt text.

Line 52 states "no runtime allocations," but the functional_status_codes library does not document allocation behavior for toRegisteredStatusCode() or whenConstOrNull, and Dart does not provide official allocation guarantees for this pattern. Replace the parenthetical comment with a neutral statement (e.g., "these methods are on StatusCode, not raw int") or remove the performance claim entirely.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@extension/mcp/prompts/cache_strategy.md` at line 52, Update the prompt text
to remove the unverified performance claim; replace the parenthetical "(no
runtime allocations)" with a neutral note such as "these methods are on
`StatusCode`, not raw `int`" (or remove it entirely) so the line referencing
`toRegisteredStatusCode()` and `whenConstOrNull(...)` only states that the
conversion is necessary because those methods exist on `StatusCode` rather than
asserting allocation behavior.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/ISSUE_TEMPLATE/performance.md:
- Line 10: Edit the guidance sentence in the performance template to fix
grammar: change "Bonus point's if you can tie this directly to user experience."
to "Bonus points if you can tie this directly to user experience." and replace
"what the performance impact is going to be." with "what the performance impact
will be." so the full sentence reads clearly and grammatically.

In @.github/ISSUE_TEMPLATE/refactor.md:
- Line 10: Fix the typo in the issue template sentence "Clearly describe what
needs to be refactored any why." by changing "any why" to "and why" so the
sentence reads "Clearly describe what needs to be refactored and why."; locate
the exact line containing that sentence in the refactor issue template and
update the copy accordingly to preserve user-facing wording.

In @.zed/debug.json:
- Line 9: Remove the trailing commas in the JSON object/array entries so the
file is valid JSON: locate the dangling commas shown as "}," in .zed/debug.json
(they appear after the last property in objects at the end of the blocks) and
delete those trailing commas so the final element in each object/array is not
followed by a comma, then validate the file with a JSON parser.

---

Outside diff comments:
In `@extension/mcp/prompts/cache_strategy.md`:
- Around line 35-42: The TTL mapping for rawStatusCode via
toRegisteredStatusCode()?.whenConstOrNull only covers some cacheable status
codes, so when isCacheable is true ttl can be null and retention becomes
backend-dependent; update the ttl computation (the code that assigns ttl from
toRegisteredStatusCode() / whenConstOrNull) to include all RFC-defined cacheable
status codes (e.g., 203, 206, 300, 405, 414, etc.) with explicit Duration values
and add a deterministic fallback Duration (or explicit non-cache action) for any
remaining registered codes so that downstream logic that checks isCacheable and
uses ttl always has a non-null, predictable TTL. Ensure you modify the same ttl
variable and related logic that relies on isCacheable to use the new explicit
mapping or fallback.
- Line 52: Update the prompt text to remove the unverified performance claim;
replace the parenthetical "(no runtime allocations)" with a neutral note such as
"these methods are on `StatusCode`, not raw `int`" (or remove it entirely) so
the line referencing `toRegisteredStatusCode()` and `whenConstOrNull(...)` only
states that the conversion is necessary because those methods exist on
`StatusCode` rather than asserting allocation behavior.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 4c4080a3-155a-4dc0-9c20-3fd74a6d466f

📥 Commits

Reviewing files that changed from the base of the PR and between fdffb78 and a513145.

📒 Files selected for processing (25)
  • .github/ISSUE_TEMPLATE/bug_report.md
  • .github/ISSUE_TEMPLATE/build.md
  • .github/ISSUE_TEMPLATE/chore.md
  • .github/ISSUE_TEMPLATE/ci.md
  • .github/ISSUE_TEMPLATE/documentation.md
  • .github/ISSUE_TEMPLATE/feature_request.md
  • .github/ISSUE_TEMPLATE/performance.md
  • .github/ISSUE_TEMPLATE/refactor.md
  • .github/ISSUE_TEMPLATE/revert.md
  • .github/ISSUE_TEMPLATE/style.md
  • .github/ISSUE_TEMPLATE/test.md
  • .github/code_of_conduct.md
  • .github/dependabot.yaml
  • .github/pull_request_template.md
  • .gitignore
  • .pubignore
  • .vscode/tasks.json
  • .zed/debug.json
  • CHANGELOG.md
  • README.md
  • example/pubspec.yaml
  • extension/mcp/prompts/cache_strategy.md
  • extension/mcp/prompts/handle_response.md
  • pubspec.yaml
  • test/src/status_code_test.dart
💤 Files with no reviewable changes (1)
  • .vscode/tasks.json

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
github-actions[bot]
github-actions bot previously approved these changes Mar 14, 2026
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
github-actions[bot]
github-actions bot previously approved these changes Mar 14, 2026
coderabbitai[bot]
coderabbitai bot previously approved these changes Mar 14, 2026
- Remove trailing comma from first debug configuration
- Remove trailing comma from second debug configuration
- Ensure valid JSON syntax
@tsinis tsinis merged commit ec80c1e into main Mar 14, 2026
16 checks passed
@tsinis tsinis deleted the docs/coderabbit-badge branch March 14, 2026 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

D-5 documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant