Skip to content

chore: add AGENTS.md for AI-assisted development #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ulises-jeremias merged 1 commit into from
Apr 20, 2026
Merged

chore: add AGENTS.md for AI-assisted development #114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Agent Instructions for create-node-app

## Overview

`create-node-app` is a CLI tool for scaffolding Node.js projects from templates.

## Tech Stack

- TypeScript
- Node.js 22+
- pnpm 10+
- Turborepo (monorepo)

## Key Commands

```bash
# Build all packages
npm run build

# Run tests
npm run test:all

# Lint
npm run lint
Comment on lines +16 to +24

@coderabbitai coderabbitai Bot Apr 20, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Unify package-manager commands with stated pnpm standard.

You declare pnpm 10+ as the package manager, but examples use npm run .... Please switch examples to pnpm (or explicitly state both are supported) to avoid agent/tooling drift. Based on learnings: Use pnpm 10+ as the package manager.

Suggested doc fix 
 ```bash
 # Build all packages
-npm run build
+pnpm build

 # Run tests
-npm run test:all
+pnpm test:all

 # Lint
-npm run lint
+pnpm lint
</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against the current code and only fix it if needed.

In @AGENTS.md around lines 16 - 24, The docs show npm commands but the repo
standard is pnpm 10+; update the example commands in AGENTS.md by replacing the
three occurrences of "npm run build", "npm run test:all", and "npm run lint"
with the pnpm equivalents "pnpm build", "pnpm test:all", and "pnpm lint" (or
explicitly note both npm/pnpm are supported), ensuring the displayed bash
snippet and any related README examples use pnpm to match the declared package
manager.


</details>

<!-- fingerprinting:phantom:triton:hawk:2503cc1a-0ea4-49ce-80f9-d81b68fdea22 -->

<!-- This is an auto-generated comment by CodeRabbit -->

```

## Code Style

- ESLint flat config
- Prettier for formatting
- TypeScript strict mode
Loading