Skip to content

Conversation

georgexu99
Copy link
Contributor

CLAUDE.md should be shared repo-wide, though individual users can add their own user-level CLAUDE.md files to add individual preferences.

This will help our claudeguy be more efficient and accurate in its spelunking.

CLAUDE.md Outdated
@@ -0,0 +1,114 @@
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
Copy link
Contributor

Choose a reason for hiding this comment

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

I wouldn't leave this in your CLAUDE.md file, rather everything in this file should be addressed to Claude.

E.g.

This document helps Claude understand the Sleuth repo structure and common development patterns.

CLAUDE.md Outdated

## Development Commands

**Always use yarn instead of npm** - this project enforces yarn usage.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
**Always use yarn instead of npm** - this project enforces yarn usage.
IMPORTANT: Never attempt to run `npm`, instead always run the equivalent `yarn` command

"IMPORTANT:" is some magic to make claude pay more attention, bold doesn't have the same effect in aggregate

- `yarn run lint` - Run linting (includes TypeScript check, ESLint, and Prettier)
- `yarn run lint:fix` - Fix linting issues automatically

### Build Commands
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd add a note here that claude should avoid running these commands as they are slow, instead prefer running test, tsc or lint to validate changes rapidly. Other you might find claude running yarn package after every file edit in rare cases.

- Computed values for derived data
- Autorun for side effects

## Development Notes
Copy link
Contributor

Choose a reason for hiding this comment

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

Two easy notes that are pretty generically helpful:

IMPORTANT: never disable a lint rule or add @ts-ignore unless explicitly asked to do so by the user.
If you are unable to solve a problem without disabling a lint rule, stop and ask the user for
guidance first.

**CRITICAL: NEVER use --no-verify flag with git commands.** This bypasses pre-commit hooks that enforce code quality and can introduce broken code into the repository. Always fix the underlying issues that cause hooks to fail instead of bypassing them. If a hook is failing, address the specific linting, formatting, or test failures it identifies.

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.

2 participants