Skip to content

Add README and CI stub, remove duplicate root styles.css - #1

Merged
OmikronApex merged 3 commits into
mainfrom
chore/readme-ci-cleanup
Jul 13, 2026
Merged

OmikronApex merged 3 commits into
mainfrom
chore/readme-ci-cleanup

Conversation

@OmikronApex

@OmikronApex OmikronApex commented Jul 13, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Add a README covering the minigame, its modifiers, repo structure, and dev commands
  • Add .github/workflows/ci.yml calling the org reusable CI (same stub as the other plugin repos)
  • Remove the duplicated root styles.css — plugin.json references assets/styles.css, which stays

🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features

    • Updated the rhythm trainer’s instrument modifier to default to “guitar/bass” while still supporting guitar/bass, piano, and drums.
  • Documentation

    • Added a README with gameplay overview, available modifiers, and development setup.
  • Chores

    • Added/updated CI workflow checks for pushes and pull requests targeting the main branch.
  • Tests

    • Added coverage for instrument normalization and config behavior via a test hook.
  • Style

    • Removed existing game UI styling, impacting the visual presentation and interface states.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 13, 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: 8a07c48b-02d8-4f45-a843-8eb410a74705

📥 Commits

Reviewing files that changed from the base of the PR and between b7eb970 and 92189bc.

📒 Files selected for processing (2)
  • game.js
  • test/config-from-modifiers.test.js
🚧 Files skipped from review as they are similar to previous changes (1)
  • game.js

📝 Walkthrough

Walkthrough

The pull request adds reusable GitHub Actions CI, documents Bongo Cat’s Rhythm Trainer, updates the instrument modifier to use guitar/bass externally while retaining guitar internally, adds configuration tests, and removes the existing stylesheet.

Changes

Project setup

Layer / File(s) Summary
Reusable CI workflow
.github/workflows/ci.yml
Adds push and pull-request triggers for main and delegates the ci job to the shared reusable workflow.
Rhythm trainer documentation
README.md
Documents gameplay, modifiers, repository structure, and npm development commands.

Instrument configuration

Layer / File(s) Summary
Instrument modifier contract and normalization
plugin.json, game.js
Changes the public instrument option from guitar to guitar/bass, maps that value to internal guitar, and exposes the configuration function for tests.
Configuration validation
test/config-from-modifiers.test.js
Tests instrument normalization, pass-through values, defaults, and preservation of other configuration fields.
Stylesheet removal
styles.css
Removes the existing game UI styling and animation rules.

Estimated code review effort: 3 (Moderate) | ~20 minutes

🚥 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 title matches key parts of the PR: README addition, CI workflow stub, and removal of the duplicate root stylesheet.
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/readme-ci-cleanup

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

@OmikronApex OmikronApex reopened this Jul 13, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 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.

Inline comments:
In @.github/workflows/ci.yml:
- Line 10: Update the reusable workflow reference in the CI configuration from
the mutable `@main` revision to a full commit SHA, using the intended reviewed
commit and preserving the existing got-feedback reusable workflow path.

In `@README.md`:
- Line 3: Update the README overview and modifier table to use a consistent
supported-instrument list: either add bass to the table’s supported entries or
remove bass from the overview sentence, while preserving the existing
documentation structure.
- Line 19: Update the Tempo (BPM) entry in the README table to explicitly
document 20 BPM increments, replacing the vague “in steps” wording while
preserving the 60–160 range and default value of 80.
🪄 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: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 0167a19a-a52d-4456-9489-334830386fec

📥 Commits

Reviewing files that changed from the base of the PR and between 3155227 and 2af7041.

📒 Files selected for processing (3)
  • .github/workflows/ci.yml
  • README.md
  • styles.css
💤 Files with no reviewable changes (1)
  • styles.css

Comment thread .github/workflows/ci.yml
Comment thread README.md
Comment thread README.md Outdated
The instrument picker now shows 'guitar/bass' (mapped to the internal
guitar input path in configFromModifiers); README tempo wording names
the 20 BPM increments.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
game.js (1)

55-59: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Add a regression test for the instrument normalization.

Please cover "guitar/bass" → "guitar" and verify that "piano", "drums", and omitted values retain their expected behavior. This protects the manifest/SDK contract from future drift.

🤖 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 `@game.js` around lines 55 - 59, Add a regression test covering the instrument
normalization performed by the configuration-building function containing the
instrument assignment: assert that “guitar/bass” becomes “guitar,” while “piano”
and “drums” remain unchanged and an omitted instrument defaults to “guitar.”
🤖 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 `@game.js`:
- Around line 55-59: Add a regression test covering the instrument normalization
performed by the configuration-building function containing the instrument
assignment: assert that “guitar/bass” becomes “guitar,” while “piano” and
“drums” remain unchanged and an omitted instrument defaults to “guitar.”

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ca26109e-2938-4e95-8e82-09dd99459c39

📥 Commits

Reviewing files that changed from the base of the PR and between 2af7041 and b7eb970.

📒 Files selected for processing (3)
  • README.md
  • game.js
  • plugin.json
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

Exposes configFromModifiers via a test-only window hook so the real
implementation (not a simulation) is pinned.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@OmikronApex

Copy link
Copy Markdown
Collaborator Author

@coderabbitai Addressed the nitpick: added test/config-from-modifiers.test.js covering guitar/bass → guitar normalization, piano/drums passthrough, the omitted-instrument default, and the full config shape. game.js now exposes configFromModifiers through a test-only hook so the real implementation is exercised.

@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
fd . -e js | rg -i "config-from-modifiers"
fd test -t d
cat test/config-from-modifiers.test.js 2>/dev/null
rg -n "configFromModifiers" game.js

Length of output: 2041


@OmikronApex Confirmed — I checked test/config-from-modifiers.test.js and the new window.feedBackMinigamesBongoCatTest.configFromModifiers hook in game.js (Line 67). The tests exercise the real implementation directly and cover the important cases: "guitar/bass" → "guitar" normalization, "piano"/"drums" passthrough, the default when instrument is omitted, and the full config shape. This looks good to me. Thanks for addressing it!

(٥⁰▿⁰) nice work

@OmikronApex
OmikronApex merged commit f2b7cf6 into main Jul 13, 2026
3 checks passed
@OmikronApex
OmikronApex deleted the chore/readme-ci-cleanup branch July 13, 2026 19:46
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