Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 955 Bytes

CONTRIBUTING.md

File metadata and controls

41 lines (32 loc) · 955 Bytes

Contributing to QuantumAI

Getting Started

  1. Fork the repository
  2. Create a virtual environment: python -m venv venv
  3. Install dependencies: pip install -r requirements.txt
  4. Install development dependencies: pip install -r requirements-dev.txt

Development Guidelines

Code Style

  • Follow PEP 8 guidelines
  • Use type hints
  • Write docstrings for all functions and classes
  • Use meaningful variable names

Testing

  • Write unit tests for new features
  • Ensure all tests pass before submitting PR
  • Maintain minimum 80% code coverage

Pull Request Process

  1. Create a feature branch
  2. Write clear commit messages
  3. Update documentation
  4. Submit PR with description of changes

Code Review Process

PRs will be reviewed for:

  • Code quality
  • Test coverage
  • Documentation
  • Performance impact
  • Security considerations

Community

  • Join our Discord server
  • Participate in weekly meetings
  • Follow our code of conduct