Add commands to run CLI in CONTRIBUTING.md #685
Conversation
|
We require contributors to sign our Contributor License Agreement, and we don"t have @AnshulYADAV007 on file. In order for us to review and merge your code, please follow our CLA guidelines. |
WalkthroughAdds a new changeset file and updates CONTRIBUTING.md with CLI local development instructions. No code or API changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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. Comment |
|
@AnshulYADAV007 is attempting to deploy a commit to the stagewise Team on Vercel. A member of the Team first needs to authorize it. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
92-98: Optional: add a brief prerequisite reminder.To reduce confusion, add a one-liner above the block: “Ensure dependencies are installed at the repo root before running the CLI.”
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.changeset/funny-months-float.md(1 hunks)CONTRIBUTING.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
{package.json,tsconfig.json,*.json,*.js,*.ts,*.md}
📄 CodeRabbit inference engine (.cursor/rules/precommit.mdc)
The scope in the commit message MUST be determined by the location of the changed files: use "root" for changes in the root directory (e.g., package.json, tsconfig.json, etc.).
Files:
CONTRIBUTING.md
🧠 Learnings (10)
📚 Learning: 2025-08-03T19:30:01.868Z
Learnt from: CR
PR: stagewise-io/stagewise#0
File: apps/cli/CLAUDE.md:0-0
Timestamp: 2025-08-03T19:30:01.868Z
Learning: Start the app in dev mode with `pnpm dev`
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-08-17T19:03:32.418Z
Learnt from: CR
PR: stagewise-io/stagewise#0
File: toolbar/core/CLAUDE.md:0-0
Timestamp: 2025-08-17T19:03:32.418Z
Learning: Make dev builds with `pnpm dev`
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-08-17T19:02:42.174Z
Learnt from: CR
PR: stagewise-io/stagewise#0
File: agent/client/CLAUDE.md:0-0
Timestamp: 2025-08-17T19:02:42.174Z
Learning: Use `pnpm dev` for dev builds; for one-time type/check builds use `pnpm build`
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-08-03T19:30:01.868Z
Learnt from: CR
PR: stagewise-io/stagewise#0
File: apps/cli/CLAUDE.md:0-0
Timestamp: 2025-08-03T19:30:01.868Z
Learning: Build the app with `pnpm build`
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-08-17T19:02:18.055Z
Learnt from: CR
PR: stagewise-io/stagewise#0
File: CLAUDE.md:0-0
Timestamp: 2025-08-17T19:02:18.055Z
Learning: Always use pnpm as package manager and for script execution
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-08-17T19:02:42.174Z
Learnt from: CR
PR: stagewise-io/stagewise#0
File: agent/client/CLAUDE.md:0-0
Timestamp: 2025-08-17T19:02:42.174Z
Learning: Make production builds with `pnpm build`
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-08-17T19:03:32.418Z
Learnt from: CR
PR: stagewise-io/stagewise#0
File: toolbar/core/CLAUDE.md:0-0
Timestamp: 2025-08-17T19:03:32.418Z
Learning: Make prod builds with `pnpm build`
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-07-18T16:47:48.652Z
Learnt from: CR
PR: stagewise-io/stagewise#0
File: .cursor/rules/conventions.mdc:0-0
Timestamp: 2025-07-18T16:47:48.652Z
Learning: When using the terminal in node.js apps use pnpm as package manager.
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-08-03T19:30:01.868Z
Learnt from: CR
PR: stagewise-io/stagewise#0
File: apps/cli/CLAUDE.md:0-0
Timestamp: 2025-08-03T19:30:01.868Z
Learning: Run tests with `pnpm test`. You have to watch the outputs and close the test runner once the tests are done because it runs in file watching mode.
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-07-18T16:47:59.946Z
Learnt from: CR
PR: stagewise-io/stagewise#0
File: .cursor/rules/monorepo-guide.mdc:0-0
Timestamp: 2025-07-18T16:47:59.946Z
Learning: Always use pnpm commands for installing, updating, and managing dependencies (e.g., pnpm install, pnpm add <package> -w, pnpm add <package> --filter <package-name>)
Applied to files:
CONTRIBUTING.md
🔇 Additional comments (1)
.changeset/funny-months-float.md (1)
1-2: Empty changeset for docs-only change is fine.This satisfies the repo’s requirement for a changeset even when no packages are affected.
| To start the CLI: | ||
|
|
||
| ```bash | ||
| pnpm build | ||
| cd apps/cli | ||
| pnpm dev -b | ||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix CLI instructions to avoid ELIFECYCLE/node_modules missing errors.
Running build before install and switching dirs is causing the reported failures. Recommend installing at the workspace root and starting CLI directly via -C.
Apply this diff:
-```bash
-pnpm build
-cd apps/cli
-pnpm dev -b
-```
+```bash
+pnpm -w install
+pnpm -C apps/cli dev
+```Notes:
- Drop “-b” unless there’s a specific need; it can forward Turbo flags unexpectedly.
- Alternative (from repo root):
pnpm dev --filter ./apps/cli
🤖 Prompt for AI Agents
In CONTRIBUTING.md around lines 92 to 98, the CLI startup steps run pnpm build
then cd into apps/cli and run pnpm dev -b which causes ELIFECYCLE/node_modules
missing errors; update the instructions to first install dependencies at the
workspace root with pnpm -w install and then start the CLI from the repo root
with pnpm -C apps/cli dev (drop the -b flag), and optionally note the
alternative pnpm dev --filter ./apps/cli for running from the root.
|
Hi @AnshulYADAV007, thanks for the PR, the update to the contribution-guide was needed! Can you please sign the cla so we can add you to the contributors? 😁 |
2 participants
Added the commands
ELIFECYCLE Command failed.
WARN Local package.json exists, but node_modules missing, did you mean to install?, and
ELIFECYCLE Command failed.
WARN Local package.json exists, but node_modules missing, did you mean to install?.
Summary by CodeRabbit