UNPKG

jondoescoding-coding-rules

Version:

CLI tool to manage custom Cursor AI rule templates for enhanced AI-assisted development

81 lines (65 loc) 1.83 kB
# Claude Code Project Setup Guide Configuration and setup recommendations for optimal Claude Code usage. ## Initial Setup ### 1. Project Structure Create a clear, organized project structure: ``` project/ ├── CLAUDE.md # Project context for Claude ├── README.md # Public documentation ├── .claudeconfig # Claude-specific settings ├── src/ # Source code ├── docs/ # Documentation └── tests/ # Test files ``` ### 2. CLAUDE.md Template ```markdown # Project: [Your Project Name] ## What This Project Does [Brief description] ## Current Status - [Status item 1] - [Status item 2] ## Key Files - `src/main.js` - Main application entry point - `src/utils/` - Utility functions - `docs/` - Project documentation ## Current Tasks - [ ] [Task 1] - [ ] [Task 2] - [ ] [Task 3] ## Important Context [Any important context Claude should know] ``` ### 3. .claudeconfig (Optional) ```json { "memory": { "persist_context": true, "key_files": ["CLAUDE.md", "README.md"], "ignore_patterns": ["node_modules/", ".git/"] }, "preferences": { "code_style": "concise", "explanation_level": "detailed" } } ``` ## Best Practices ### File Organization - Keep related files together - Use descriptive file names - Maintain consistent structure ### Documentation - Update CLAUDE.md regularly - Include code examples in documentation - Explain complex logic with comments ### Communication - Be specific about what you want - Provide context for requests - Reference specific files and line numbers ## Workflow Integration 1. **Start Session**: Review CLAUDE.md 2. **During Work**: Update context as needed 3. **End Session**: Update CLAUDE.md with progress 4. **Next Session**: Reference previous work via CLAUDE.md