Skip to content

Commit 6c9e17e

Browse files
committed
update claude.md
1 parent 973a648 commit 6c9e17e

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

CLAUDE.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# CLAUDE.md
22

3-
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
3+
This document helps Claude understand the Sleuth repo structure and common development patterns.
44

55
## Project Overview
66

77
Sleuth is an Electron-based Slack Log Viewer application built with React, TypeScript, and MobX for state management. It processes various types of log files (browser, webapp, mobile, installer, etc.) and provides a comprehensive UI for viewing, filtering, and analyzing log data.
88

99
## Development Commands
1010

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

1313
### Core Commands
1414

@@ -19,6 +19,7 @@ Sleuth is an Electron-based Slack Log Viewer application built with React, TypeS
1919
- `yarn run lint` - Run linting (includes TypeScript check, ESLint, and Prettier)
2020
- `yarn run lint:fix` - Fix linting issues automatically
2121

22+
2223
### Build Commands
2324

2425
- `yarn run package` - Package the app for current platform
@@ -112,6 +113,14 @@ The app follows standard Electron patterns with three main processes:
112113

113114
## Development Notes
114115

116+
IMPORTANT: never disable a lint rule or add @ts-ignore unless explicitly asked to do so by the user.
117+
If you are unable to solve a problem without disabling a lint rule, stop and ask the user for
118+
guidance first.
119+
120+
note that you (Claude) should avoid running these commands as they are slow, instead prefer running test, tsc or lint to validate changes rapidly.
121+
122+
**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.
123+
115124
### Security
116125

117126
- Context isolation enabled - use `contextBridge` in preload

0 commit comments

Comments
 (0)