forked from hyperliquid-dex/hyperliquid-python-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Labels
claude-automationconfigurationdocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
@claude Please create a new CLAUDE.md file in the repository root that defines code style guidelines, review criteria, project-specific rules, and preferred patterns for this Hyperliquid Python SDK project.
File Structure Required:
# Claude Code Configuration for Hyperliquid Python SDK
## Project Overview
[Brief description of the Python SDK for Hyperliquid API trading]
## Code Style Guidelines
- Follow existing Python patterns in the codebase
- Use type hints for all new functions and methods
- Maintain backwards compatibility for all public APIs
- Follow PEP 8 style guidelines with project-specific exceptions
## Development Workflow
- Use Poetry for dependency management (Python 3.10+ required)
- Run `make install` for setup, `make test` for testing, `make lint` for linting
- All examples should remain functional after changes
- Configuration files go in examples/config.json
## Review Criteria
- Security considerations for trading API interactions
- Performance implications for trading operations
- Proper error handling and logging
- Comprehensive test coverage for new features
## Project-Specific Rules
- Never break existing API methods or signatures
- All trading operations must have proper error handling
- Rate limiting considerations for API calls
- Secure handling of API keys and credentials
## Preferred Patterns
- [Document existing patterns found in the codebase]
- Exception handling strategies
- Logging conventions
- API response processing patterns
## Testing Requirements
- Unit tests for all new functionality
- Integration tests where applicable
- Example validation after changes
- No test failures allowed in production merges
## Documentation Standards
- Clear docstrings for all public methods
- Update README.md for significant changes
- Maintain example code in examples/ directory
- Keep CHANGELOG.md updated for releasesRequirements:
- Analyze the existing codebase to understand current patterns
- Review examples/ directory to understand usage patterns
- Check existing test structure and conventions
- Document any specific trading/API related considerations
- Create comprehensive guidelines that Claude Code can follow
Integration:
- This file will guide all future Claude Code operations
- Should be referenced in workflow custom_instructions
- Must align with existing project structure and patterns
Please analyze the codebase thoroughly and create comprehensive guidelines that ensure consistent, secure, and high-quality code generation.
Metadata
Metadata
Assignees
Labels
claude-automationconfigurationdocumentationImprovements or additions to documentationImprovements or additions to documentation