Merged
Conversation
|
Caution Review failedPull request was closed or merged during review 📝 WalkthroughWalkthroughAdds GitHub templates/config, CI workflow for Pages, site assets, project docs (CODE_OF_CONDUCT, CONTRIBUTING, SECURITY, README edits), and small runtime-state changes: validated gameplay-packet counting and adjusted bridgeState resolution on resume, plus corresponding test updates. Changes
Sequence Diagram(s)sequenceDiagram
participant Restorer as Checkpoint Restorer
participant Validator as Packet Validator
participant Resolver as BridgeState Resolver
participant Runtime as Runtime State
Restorer->>Validator: provide restored.packets
Validator-->>Restorer: validated packets + validatedCount
Restorer->>Resolver: provide restored.bridgeState, restored.exportUrl
Resolver-->>Restorer: computed bridgeState
Restorer->>Runtime: assemble resumed state (phase, bridgeState, gameplayPacketSummary)
Runtime-->>Restorer: resumed runtime state returned
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 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.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
73-89:⚠️ Potential issue | 🟠 MajorClarify full-tab as temporary/debug-only, not a target runtime surface.
Line 78/Line 81 and Line 144 currently read like full-tab is a first-class target path. That can steer contributors away from the intended popup/side-panel shipped surface.
Suggested doc tweak
- BG --> FT[Host page in full tab] + BG --> FT[Host page in full tab (temporary debug/migration path)] @@ -5. Use **Move to full tab** and confirm the run transfers. +5. (Optional debug) Use **Move to full tab** and confirm transfer still works during migration. +6. Confirm popup/side-panel-style flow remains the primary shipped experience.Based on learnings: The visible runtime surface must be extension-owned and constrained like a popup or side panel; do not treat a full browser tab as the final shipped runtime surface.
Also applies to: 140-145
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 73 - 89, Update the README mermaid diagram and surrounding text to clarify that the "FT[Host page in full tab]" path is only for temporary/debug use and not a supported production runtime: annotate or rename FT to something like "FT[Host page in full tab (debug-only)]", and update any prose references around the RH, PW, FT nodes (lines referencing FT/Host page in full tab and the paragraphs around 140-145) to explicitly state full-tab is a development-only surface while PU (Extension popup UI) / side-panel remain the intended shipped surfaces; ensure the diagram arrows (BG -> FT and FT -> RH) stay for completeness but are labeled or footnoted as debug-only to avoid implying full-tab is a first-class runtime.
🤖 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/config.yml:
- Around line 1-11: The contact_links entries contain two broken URLs; update or
remove the entries for "Contributing guide" (url currently set to
https://github.com/bdtran2002/ForkOrFry/blob/main/CONTRIBUTING.md) and "Project
site" (url currently set to https://bdtran2002.github.io/ForkOrFry/) in the
config.yml's contact_links block: either correct them to valid, reachable URLs
or delete those contact_links objects so only the working "Project README" link
remains; ensure you keep the YAML structure (keys: contact_links, name, url,
about) and do not alter blank_issues_enabled.
In `@docs/site/index.html`:
- Line 70: Replace the hardcoded prerelease anchor in the footer ("Current
prerelease: <a ...>v0.0.1-beta.1</a>") with a dynamic source: either point the
href/text to GitHub's releases/latest URL or fetch the latest tag at
build/runtime (via GitHub API or a small client-side script) and inject the tag
into the same anchor text so it never goes stale; update the anchor element with
the new dynamic approach and keep the visible label "Current prerelease:" so
visitors still see the same UI.
In `@docs/site/styles.css`:
- Around line 95-118: Add explicit keyboard focus styles for interactive
controls by defining :focus-visible rules for .button and links under
.subtle-links (and any other interactive selectors you have) so keyboard users
get a visible focus ring without changing mouse focus behavior; update the CSS
to include .button:focus-visible and .subtle-links a:focus-visible with a clear
outline or box-shadow, ensure the focus styling uses accessible contrast and
matches your hover/active transitions, and avoid using outline: none so the
focus remains visible for keyboard users.
In `@README.md`:
- Around line 45-49: The first-time setup in the README's "How to try it" steps
is missing dependency installation; update the ordered steps (around the
existing "Run `npm run build` in `extension/`" and the list of Firefox load
steps) to insert a prior step to run `npm install` (or `npm ci`) inside the
`extension/` directory so dependencies are installed before running `npm run
build`, and mention which package manager (npm/yarn/pnpm) is supported if
applicable.
---
Outside diff comments:
In `@README.md`:
- Around line 73-89: Update the README mermaid diagram and surrounding text to
clarify that the "FT[Host page in full tab]" path is only for temporary/debug
use and not a supported production runtime: annotate or rename FT to something
like "FT[Host page in full tab (debug-only)]", and update any prose references
around the RH, PW, FT nodes (lines referencing FT/Host page in full tab and the
paragraphs around 140-145) to explicitly state full-tab is a development-only
surface while PU (Extension popup UI) / side-panel remain the intended shipped
surfaces; ensure the diagram arrows (BG -> FT and FT -> RH) stay for
completeness but are labeled or footnoted as debug-only to avoid implying
full-tab is a first-class runtime.
🪄 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: ffc1fe94-ef97-47d0-b93a-9cf92eb41867
📒 Files selected for processing (14)
.github/ISSUE_TEMPLATE/bug_report.md.github/ISSUE_TEMPLATE/config.yml.github/ISSUE_TEMPLATE/feature_request.md.github/PULL_REQUEST_TEMPLATE.md.github/release.yml.github/workflows/pages.ymlCODE_OF_CONDUCT.mdCONTRIBUTING.mdREADME.mdSECURITY.mddocs/site/index.htmldocs/site/styles.cssextension/src/features/runtime-frame/upstream-runtime-state.tsextension/tests/upstream-runtime.test.ts
Owner
Author
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
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.
This pull request introduces major improvements to project documentation, contribution guidelines, security policy, and GitHub workflow automation. It adds a GitHub Pages landing site, refines the README for clarity and onboarding, and establishes clear templates for issues and pull requests. Additionally, it fixes a bug in gameplay packet summarization and improves state restoration logic. The most important changes are summarized below.
Documentation and Community Standards
CONTRIBUTING.md,CODE_OF_CONDUCT.md, andSECURITY.mdfiles to clarify contribution process, expected behavior, and security reporting. [1] [2] [3]README.mdwith clearer project status, setup instructions, project links, and highlights; improved onboarding for contributors and users. [1] [2] [3]GitHub Workflow and Automation
.github/release.ymlto categorize changelog entries by label for automated release notes..github/workflows/pages.yml) to build and deploy the new landing page to GitHub Pages.Project Site
docs/site/with a styledindex.htmlandstyles.css, providing a public-facing summary and links for the project. [1] [2]Bug Fixes and Code Improvements
createResumeUpstreamRuntimeStateto handle error states more robustly and ensure correct session recovery; updated tests accordingly. [1] [2]Summary by CodeRabbit
New Features
Documentation
Bug Fixes
Tests
Chores