project-iris 0.2.1 → 0.2.2

package/lib/installer.js

@@ -230,6 +230,47 @@ async function installVSCodeExtension(selectedToolKeys) {
   return installed;
 }
 
+/**
+ * Install CLAUDE.md to .claude/ folder
+ * This provides Claude with project-agnostic quality guidelines
+ * @returns {boolean} Whether file was installed
+ */
+async function installClaudeMd() {
+  const sourcePath = path.join(__dirname, '..', 'templates', 'CLAUDE.md');
+  const targetDir = '.claude';
+  const targetPath = path.join(targetDir, 'CLAUDE.md');
+
+  // Check if source exists
+  if (!await fs.pathExists(sourcePath)) {
+    console.log(theme.dim('  CLAUDE.md template not found, skipping...'));
+    return false;
+  }
+
+  // Ensure .claude directory exists
+  await fs.ensureDir(targetDir);
+
+  // Check if CLAUDE.md already exists
+  if (await fs.pathExists(targetPath)) {
+    // Read existing content to check if it's ours
+    const existing = await fs.readFile(targetPath, 'utf8');
+    if (existing.includes('installed by iris') || existing.includes('project-iris')) {
+      // Our file, safe to overwrite
+      await fs.copy(sourcePath, targetPath, { overwrite: true });
+      CLIUtils.displayStatus('', 'Updated CLAUDE.md', 'success');
+      return true;
+    } else {
+      // User's own CLAUDE.md, don't overwrite
+      console.log(theme.dim('  Existing CLAUDE.md found, skipping (won\'t overwrite user file)'));
+      return false;
+    }
+  }
+
+  // Install fresh
+  await fs.copy(sourcePath, targetPath);
+  CLIUtils.displayStatus('', 'Installed CLAUDE.md with quality guidelines', 'success');
+  return true;
+}
+
 async function install() {
   // Initialize analytics (respects opt-out env vars)
   analytics.init();
@@ -316,6 +357,9 @@ async function install() {
   try {
     const filesCreated = await installFlow(selectedFlow, selectedToolKeys);
 
+    // Install CLAUDE.md with quality guidelines
+    await installClaudeMd();
+
     // Install VS Code extension if applicable
     await installVSCodeExtension(selectedToolKeys);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "project-iris",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Multi-agent orchestration system for AI-native software development. Delivers AI-DLC, Agile, and custom SDLC flows as markdown-based agent systems.",
   "main": "lib/installer.js",
   "bin": {
@@ -38,6 +38,7 @@
     "flows/",
     "lib/",
     "scripts/",
+    "templates/",
     "README.md"
   ],
   "dependencies": {

package/templates/CLAUDE.md

@@ -0,0 +1,88 @@
+# Claude Instructions
+
+## Core Principles
+
+1. **Read before writing** - Understand existing code before modifying
+2. **Minimal changes** - Solve the problem, nothing more
+3. **Follow existing patterns** - Match the codebase style exactly
+4. **Ask when unclear** - Don't guess at requirements
+
+---
+
+## Before Writing Code
+
+- Read the files you'll modify - understand the patterns used
+- Search for existing utilities before creating new ones
+- Check if similar problems are solved elsewhere in the codebase
+- Understand the "why" behind existing code, not just the "what"
+
+---
+
+## Code Quality
+
+### Keep It Simple
+
+- Solve the current problem, not hypothetical future ones
+- No abstractions for single-use cases
+- Three similar lines > premature helper function
+- Delete unused code completely (no `_unused` prefixes)
+
+### Only Add What's Needed
+
+- No feature flags for simple changes
+- No backwards-compatibility shims when you can just change code
+- No defensive programming against impossible scenarios
+- No gold-plating or "while I'm here" improvements
+
+### Error Handling
+
+- Validate at system boundaries only (user input, APIs, file I/O)
+- Trust internal code - don't defensively check everything
+- No empty catch blocks
+- Let errors propagate when callers should handle them
+
+---
+
+## What NOT To Do
+
+- Don't add comments explaining obvious code
+- Don't add types/docstrings to code you didn't change
+- Don't refactor surrounding code when fixing a bug
+- Don't create utils/helpers for one-time operations
+- Don't add tests for trivial code (getters, pass-through)
+- Don't "improve" working code that isn't part of the task
+- Don't guess at missing requirements - ask first
+
+---
+
+## Security Essentials
+
+- Never hardcode secrets, keys, or credentials
+- Validate and sanitize all user input
+- Use parameterized queries (no string concatenation for SQL)
+- Escape output in templates to prevent XSS
+- Check file paths to prevent directory traversal
+
+---
+
+## Testing
+
+- Test behavior, not implementation
+- One assertion per test when possible
+- Name tests by what they verify: `test_returns_empty_list_when_no_items`
+- Don't mock what you don't own
+- Skip tests for trivial code
+
+---
+
+## Communication
+
+- Be direct and concise
+- State what you're doing before doing it
+- If blocked, explain why and ask for guidance
+- Confirm destructive operations before executing
+- Summarize changes after completing a task
+
+---
+
+<!-- installed by iris (project-iris) - safe to update with: npx project-iris install -->