Skip to content

Conversation

MH4GF
Copy link
Member

@MH4GF MH4GF commented Oct 10, 2025

Issue

  • resolve: (none - documentation improvement)

Why is this change needed?

Add reference to test-principles.md in CLAUDE.md to ensure Claude Code follows established testing principles when writing tests.

Summary

  • Added Testing section to CLAUDE.md that references @docs/test-principles.md

Test plan

  • Verify CLAUDE.md renders correctly
  • Confirm @docs/test-principles.md reference works in Claude Code

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Expanded CSS/Testing guidance with a new Testing subsection that references established test principles for consistency.
    • Clarifies expectations for testing approaches without altering application behavior.
    • No functional, UI, or performance changes; user experience remains unchanged.

Reference test-principles.md for test writing guidelines.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Copy link

vercel bot commented Oct 10, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
liam-app Ready Ready Preview Comment Oct 10, 2025 10:04am
liam-assets Ready Ready Preview Comment Oct 10, 2025 10:04am
liam-erd-sample Ready Ready Preview Comment Oct 10, 2025 10:04am
liam-storybook Ready Ready Preview Comment Oct 10, 2025 10:04am
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
liam-docs Ignored Ignored Preview Oct 10, 2025 10:04am

Copy link

giselles-ai bot commented Oct 10, 2025

Unexpected error on running flow

Step Status Updated(UTC)
1 Oct 10, 2025 9:56am
2 Oct 10, 2025 9:58am
3 Oct 10, 2025 9:58am

Copy link

supabase bot commented Oct 10, 2025

Updates to Preview Branch (chore-claude-md-6) ↗︎

Deployments Status Updated
Database Fri, 10 Oct 2025 09:59:41 UTC
Services Fri, 10 Oct 2025 09:59:41 UTC
APIs Fri, 10 Oct 2025 09:59:41 UTC

Tasks are run on every commit but only new migration files are pushed.
Close and reopen this PR if you want to apply changes from existing seed or migration files.

Tasks Status Updated
Configurations Fri, 10 Oct 2025 09:59:46 UTC
Migrations Fri, 10 Oct 2025 09:59:49 UTC
Seeding Fri, 10 Oct 2025 09:59:51 UTC
Edge Functions Fri, 10 Oct 2025 09:59:51 UTC

View logs for this Workflow Run ↗︎.
Learn more about Supabase for Git ↗︎.

Copy link
Contributor

coderabbitai bot commented Oct 10, 2025

Walkthrough

Adds a Testing subsection to CLAUDE.md under CSS/Testing guidance, directing readers to follow principles in docs/test-principles.md. No code or control flow changes.

Changes

Cohort / File(s) Summary of changes
Documentation
CLAUDE.md
Added a Testing subsection under CSS/Testing, referencing docs/test-principles.md.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

Review effort 2/5

Suggested reviewers

  • hoshinotsuyoshi
  • FunamaYukina
  • NoritakaIkeda
  • junkisai

Poem

A nibble of docs, a hop through the grass,
I annotate trails where testers will pass.
Follow the scroll to principles true—
Carrots of wisdom for CSS crew.
Thump-thump! I approve this guiding class. 🥕🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly and accurately describes the main documentation change by specifying that testing guidance is being added to CLAUDE.md, making it clear and specific for reviewers scanning the history.
Description Check ✅ Passed The description includes the required “## Issue” section with a resolve entry and the “## Why is this change needed?” section with a clear justification, and it further provides a summary and test plan to guide reviewers and ensure documentation quality.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore-claude-md-6

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.

Copy link

giselles-ai bot commented Oct 10, 2025

Check changeset necessity

Status: NOT REQUIRED

Reason:

  • This PR modifies documentation only (CLAUDE.md) and does not touch any published package code.
  • No changes in target packages: @liam-hq/cli, @liam-hq/erd-core, @liam-hq/schema, or @liam-hq/ui.
  • No user-facing behavior, API, feature, or performance changes are introduced.
  • Falls under “Comments or documentation only” in Non-user-facing changes; even the referenced docs path (@liam-hq/docs) is on the ignore list.

Changeset (copy & paste):

N/A – docs-only change; do not create a changeset.

Copy link
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: 0

🧹 Nitpick comments (1)
CLAUDE.md (1)

114-117: Add a Markdown link alongside the @ reference

- - Follow principles in @docs/test-principles.md
+ - Follow principles in @docs/test-principles.md ([Testing principles](docs/test-principles.md))
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 227ab97 and 2a81fc9.

📒 Files selected for processing (1)
  • CLAUDE.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: _e2e-tests (Mobile Safari)
  • GitHub Check: security-review
  • GitHub Check: Supabase Preview

@MH4GF MH4GF marked this pull request as ready for review October 10, 2025 09:59
@MH4GF MH4GF requested a review from a team as a code owner October 10, 2025 09:59
@MH4GF MH4GF requested review from NoritakaIkeda, Copilot, junkisai and sasamuku and removed request for a team October 10, 2025 09:59
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds testing guidance to the CLAUDE.md documentation file to ensure Claude Code follows established testing principles when writing tests.

  • Added a new Testing section that references the established test principles documentation

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

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