Skip to content

Commit 024013b

Browse files
committed
Update CLAUDE.md - fix stale install docs and add changelog guideline
- Remove outdated --production flags from package manager install commands - Add best practice #8: changelog discipline for user-facing changes only - Update module descriptions for clarity
1 parent 0f5fbb2 commit 024013b

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

CLAUDE.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ shipnode (main entry)
4444
- **core.sh**: Globals, colors, logging (error/success/info/warn), OS detection, Gum install
4545
- **release.sh**: Zero-downtime deploy (timestamps, symlinks, health checks, rollback)
4646
- **database.sh**: PostgreSQL setup
47-
- **users.sh**: User provisioning helpers
47+
- **users.sh**: User provisioning (creation, SSH keys, permissions, sudo, revocation)
4848
- **framework.sh**: Framework detection from package.json (Express, NestJS, Next.js, React, etc.)
49-
- **validation.sh**: Input validation (IP, port, domain, SSH), user creation/management
49+
- **validation.sh**: Input validation (IP, port, domain, SSH, remote port checks)
5050
- **prompts.sh**: Interactive prompts with Gum UI fallback
5151
- **pkg-manager.sh**: Package manager detection (npm/yarn/pnpm/bun) from lockfiles, installation on remote server
5252
- **templates.sh**: Framework templates for init
@@ -184,7 +184,7 @@ Sourced as bash, key variables:
184184
- yarn.lock → yarn
185185
- default → npm
186186
4. Generate commands:
187-
- Install: `bun install --production` | `pnpm install --prod` | `yarn install --production` | `npm install --omit=dev`
187+
- Install: `bun install` | `pnpm install` | `yarn install` | `npm install`
188188
- Run: `<pm> run <script>`
189189
- PM2: `pm2 start bun -- start` | `pm2 start npm -- start` | etc.
190190

@@ -302,6 +302,8 @@ Auto-detects port from package.json scripts.
302302
4. **Naming**: `cmd_<name>()` for commands, descriptive for helpers
303303
5. **Error handling**: `error()` for fatal, `warn()` for non-fatal
304304
6. **Comments**: Complex logic only, code should be self-documenting
305+
7. **Search before implementing**: Before writing any new function, search the entire codebase with Grep to check if it already exists. Functions may be defined in different modules than expected.
306+
8. **Changelog discipline**: CHANGELOG.md is for end users. Only log user-facing changes (features, behavior changes, bug fixes). Never log internal doc edits, CLAUDE.md updates, or refactors with no external effect.
305307

306308
## Troubleshooting
307309

0 commit comments

Comments
 (0)