Developer Guide¶
Welcome to the MolPy Developer Guide! This section provides comprehensive information for contributors and developers who want to extend, modify, or contribute to MolPy.
Quick Start¶
New to contributing? Start here:
- Contributing Guide - Learn how to contribute to MolPy
- Development Setup - Set up your development environment
- Coding Style - Follow MolPy's coding standards
- Testing - Write and run tests
Architecture & Design¶
Understand MolPy's internal architecture and design patterns:
- Architecture Overview - Core design principles and package structure
- Wrapper & Adapter Patterns - Design patterns with examples
Development Workflow¶
Setting Up¶
Get your development environment ready:
- Development Setup - Detailed setup instructions for all platforms
- Tools - Development tools and their configurations
Writing Code¶
Follow these guidelines when writing code:
- Coding Style - Style guide and best practices
- Testing - Testing guidelines and examples
- Architecture - Understanding the codebase structure
Contributing¶
Ready to submit your changes?
- Contributing Guide - Contribution workflow and guidelines
- Release Process - How releases are made
Core Principles¶
MolPy is built on these principles:
- Predictable - Clear data model with minimal surprises
- Well-tested - Every feature backed by comprehensive tests
- Documented - User-facing features have docs and examples
- Type-safe - Full type hints throughout the codebase
- Composable - Small, focused components that work together
Getting Help¶
Need assistance?
- GitHub Issues - Report bugs or request features
- GitHub Discussions - Ask questions and discuss ideas
- Documentation - Browse the full documentation
Recognition¶
We value all contributions! Contributors are recognized in:
- Project README
- Release notes
- Documentation credits
Thank you for contributing to MolPy! 🎉