Claude.md for Open Source Library Development

# Project: DataValidator - Python Data Validation Library


## Library Design Principles

- **API Design**: Simple, intuitive, and Pythonic

- **Dependencies**: Minimal external dependencies

- **Compatibility**: Python 3.8+ support

- **Performance**: Optimize for speed and memory efficiency

- **Documentation**: Comprehensive with examples


## Development Workflow

1. Create feature branch: `feature-[functionality]` or `fix-[issue-number]`

2. Write tests first (TDD approach)

3. Ensure 100% test coverage for new code

4. Update documentation and examples

5. Run full test suite across Python versions: `tox`

6. Update CHANGELOG.md with clear user-facing description


## Code Quality Standards

- Follow PEP 8 with line length limit of 88 characters

- Use type hints for all public APIs

- Docstrings required for all public functions/classes (Google style)

- Use dataclasses or Pydantic for structured data

- Implement proper error handling with custom exceptions


## Project Structure

- `/src/datavalidator/`: Main library code

- `/tests/`: Comprehensive test suite

- `/docs/`: Sphinx documentation

- `/examples/`: Usage examples and tutorials

- `/benchmarks/`: Performance testing scripts


## Testing Requirements

- Unit tests with pytest for all functionality

- Property-based testing with Hypothesis for edge cases

- Performance benchmarks for critical paths

- Integration tests with popular data libraries (pandas, numpy)

- Test matrix: Python 3.8, 3.9, 3.10, 3.11, 3.12


## Documentation Standards

- README with quick start guide and installation

- API documentation generated from docstrings

- Tutorial notebooks for common use cases

- Performance guidelines and best practices

- Migration guides for major version changes


## Release Process

- Semantic versioning (MAJOR.MINOR.PATCH)

- Automated testing on multiple Python versions

- Code coverage reports and quality metrics

- Security scanning for vulnerabilities

- Automated PyPI releases via GitHub Actions


## Community Guidelines

- Welcome contributions with clear CONTRIBUTING.md

- Issue templates for bugs and feature requests

- Code of conduct for inclusive community

- Regular maintenance and dependency updates

- Responsive to community feedback and issues

Comments

Post a Comment

Popular posts from this blog

Claude.md for Python Data Science

# Project: Customer Analytics Pipeline ## Development Standards - **Language**: Python 3.11+ - **Code Style**: Follow PEP 8 strictly, use Black for formatting - **Type Hints**: Required for all function signatures and class definitions - **Documentation**: Docstrings required for all public functions and classes ## Workflow Requirements 1. Create feature branch: `analysis-[description]` or `model-[description]` 2. Write unit tests for all data processing functions 3. Run `pytest` and ensure all tests pass 4. Run `black .` and `flake8` before committing 5. Update relevant documentation in `/docs` if adding new features ## Project Structure - `/src/data`: Data ingestion and preprocessing modules - `/src/models`: ML model definitions and training scripts   - `/src/analysis`: Exploratory analysis notebooks and scripts - `/src/utils`: Shared utility functions - `/tests`: Comprehensive test suite - `/configs`: Configuration files for different environments ## Data Handling Standards...
Read more

Worktree Prompt (Separate Directories for Different Features - So You Can Work in Parallel)

NOTE : click on the code sections to copy ( Save this as .claude/commands/parallel-work.md) I want to develop features in parallel for my expense tracker app using Git worktrees: $ARGUMENTS Think about how to divide the work up into separate features unless this has been clearly explained already. Please help me set up the worktree environment: 1. For each feature mentioned, create a worktree at ../expense-tracker-[feature-name] with branch feature/[feature-name] 2. Set up the development environment in each worktree 3. List all worktrees to confirm they were created 4. Explain what each worktree will contain and how they're isolated I want to be able to work on all features simultaneously without conflicts. That's for creation. When you're done: (Save this as .claude/commands/integrate-parallel-work.md) I have features developed in parallel worktrees that I need to integrate: $ARGUM...
Read more

Claude.md for Responsive Mobile App Development with React Native

 # Project: FitnessTracker Mobile App ## Platform Requirements - **Framework**: React Native 0.72+ with TypeScript - **State Management**: Redux Toolkit with RTK Query - **Navigation**: React Navigation v6 - **UI Library**: Native Base for consistent design - **Platform Support**: iOS 14+ and Android API 24+ ## Branch Strategy 1. Create feature branches: `mobile-[feature-name]` 2. Use conventional commits: `feat:`, `fix:`, `refactor:`, etc. 3. Test on both iOS and Android before committing 4. Run `npm run lint` and `npm run type-check` before commits ## Code Organization - **Screens**: `/src/screens/[FeatureName]/[ScreenName]Screen.tsx` - **Components**: `/src/components/[ComponentName]/index.tsx` - **Navigation**: `/src/navigation/[NavigatorName]Navigator.tsx` - **Services**: `/src/services/[serviceName].ts` - **Store**: `/src/store/slices/[featureName]Slice.ts` ## Mobile-Specific Standards - Use React Native's built-in components before third-party libraries - Implement proper er...
Read more