Skip to content

Latest commit

 

History

History
94 lines (68 loc) · 1.47 KB

contributing.md

File metadata and controls

94 lines (68 loc) · 1.47 KB

Contributing to Elamonica

Thank you for your interest in contributing to Elamonica!

Development Setup

Fork and Clone

git clone https://github.com/yourusername/elamonica.git
cd elamonica/community

Install Development Dependencies

pip install -e ".[dev]"

Run Tests

pytest

Code Formatting

black src/
ruff check src/

Code Standards

Python Style

  • Follow PEP 8
  • Use type hints
  • Write docstrings for all public APIs
  • Maximum line length: 88 characters

Documentation

  • Update documentation for new features
  • Include code examples
  • Add docstrings with Args, Returns, Raises

Testing

  • Write tests for new features
  • Maintain >80% code coverage
  • Test edge cases

Pull Request Process

  1. Create a feature branch
  2. Make your changes
  3. Add tests
  4. Update documentation
  5. Run tests and formatting
  6. Submit pull request

PR Guidelines

  • Clear description of changes
  • Reference related issues
  • Include tests
  • Update CHANGELOG

Reporting Issues

Bug Reports

Include:

  • Python version
  • Elamonica version
  • Steps to reproduce
  • Expected vs actual behavior
  • Error messages

Feature Requests

Include:

  • Use case description
  • Proposed API
  • Implementation ideas

Code Review

All submissions require review. We review:

  • Code quality
  • Test coverage
  • Documentation
  • Performance impact

License

By contributing, you agree that your contributions will be licensed under Apache 2.0.