Update Claude plugin command and improve documentation consistency#118
Update Claude plugin command and improve documentation consistency#118tobimeira wants to merge 4 commits into
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Documents the repository structure, skill file format, key conventions (npx-first Firebase CLI usage), development workflows, branch strategy, CI/CD automation, and multi-platform configuration files. https://claude.ai/code/session_01AmV45yVaRjj5FcHUmN3Lj1
- Use 'firebase-skills/' as the root dir name to match README.md - Update symlink example path to use 'firebase-skills' consistently - Replace hardcoded reviewer usernames with 'designated repository maintainers' https://claude.ai/code/session_01AmV45yVaRjj5FcHUmN3Lj1
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces CLAUDE.md, a comprehensive codebase guide for the Firebase Agent Skills repository. The document outlines the project structure, skill file formats, development workflows, and CI/CD processes. Feedback was provided to address inconsistencies in the documentation regarding skill naming conventions and the MCP configuration example, ensuring they align with existing repository patterns.
|
|
||
| ```yaml | ||
| --- | ||
| name: firebase-{feature-name} # kebab-case, matches directory name |
There was a problem hiding this comment.
The naming convention firebase-{feature-name} specified here is inconsistent with several skills listed in the "Repository Structure" section, such as xcode-project-setup and the developing-genkit-* skills. It would be more accurate to use a more general placeholder to reflect the actual directory naming policy.
| name: firebase-{feature-name} # kebab-case, matches directory name | |
| name: {skill-name} # kebab-case, matches directory name |
| "args": ["-y", "firebase-tools@latest", "mcp", "--dir", "."], | ||
| "env": { "IS_FIREBASE_MCP": "true" } |
There was a problem hiding this comment.
This MCP configuration example is inconsistent with the existing gemini-extension.json file in the repository. The example includes --dir . and uses the environment variable IS_FIREBASE_MCP, whereas gemini-extension.json omits the directory flag and uses IS_GEMINI_CLI_EXTENSION. Since this is described as the entry point for "all platforms", these should be aligned or the differences should be clarified to ensure documentation consistency.
| "args": ["-y", "firebase-tools@latest", "mcp", "--dir", "."], | |
| "env": { "IS_FIREBASE_MCP": "true" } | |
| "args": ["-y", "firebase-tools@latest", "mcp"], | |
| "env": { "IS_GEMINI_CLI_EXTENSION": "true" } |
3 participants
Summary
This PR adds a
CLAUDE.mdfile to the repository root, providing a comprehensive codebase guide for AI assistants (Claude Code, Cursor, GitHub Copilot, Gemini CLI, etc.).Changes
CLAUDE.md: A structured guide covering project overview, repository structure, skill file format, key conventions, development workflows, branch strategy, CI/CD pipeline, and multi-platform configuration reference.CLAUDE.md.Motivation
Having a
CLAUDE.mdat the repo root helps AI coding assistants quickly understand the codebase structure, conventions, and workflows, improving the quality and consistency of AI-assisted contributions.