Skip to content

Conversation

@raegAI
Copy link
Owner

@raegAI raegAI commented Jun 1, 2025

This PR adds a comprehensive CLAUDE.md configuration file that defines code style guidelines, review criteria, project-specific rules, and preferred patterns for the Hyperliquid Python SDK.

Key Features

  • Project Overview: Clear description of the SDK's purpose
  • Code Style Guidelines: Python version requirements, type hints, formatting with Black
  • Development Workflow: Poetry commands, testing with pytest, linting procedures
  • Review Criteria: API compatibility, type safety, security considerations
  • Project-Specific Rules: API structure patterns, signing requirements, configuration handling
  • Preferred Patterns: TypedDict usage, error handling, WebSocket management
  • Testing Requirements: pytest with VCR.py, coverage reporting, test conventions
  • Documentation Standards: README maintenance, example structure, error messaging

Codebase Analysis

This configuration was created by analyzing the existing codebase patterns including:

  • hyperliquid/ module structure (api.py, info.py, exchange.py, websocket_manager.py)
  • utils/ directory (types.py, constants.py, signing.py, error.py)
  • examples/ directory usage patterns
  • tests/ structure and VCR cassettes
  • pyproject.toml configuration
  • Makefile commands

Integration

This file will guide all future Claude Code operations and ensures consistent, secure, and high-quality code generation aligned with existing project patterns.

Closes #7

- Add comprehensive Claude Code configuration for Hyperliquid Python SDK
- Document code style guidelines based on existing patterns
- Include development workflow with Poetry and Make commands
- Define review criteria and project-specific rules
- Add testing requirements with pytest and VCR
- Document preferred patterns from codebase analysis
- Include integration guidelines and common patterns

Co-authored-by: raegAI <[email protected]>
@raegAI raegAI merged commit 063c23a into master Jun 1, 2025
3 of 4 checks passed
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.

[CONFIG] Create CLAUDE.md Configuration File

2 participants