Skip to content

Contributing

Thank you for your interest in contributing to phased-array-systems!

For detailed contribution guidelines, please see:

CONTRIBUTING.md on GitHub

Quick Start

# Clone and install
git clone https://github.com/jman4162/phased-array-systems.git
cd phased-array-systems
pip install -e ".[dev,docs,plotting]"

# Run tests
pytest tests/ -v

# Run linting
ruff check .
ruff format .

Ways to Contribute

  • Bug Reports: Open an issue with reproducible example
  • Documentation: Fix typos, improve explanations
  • Code: New features, bug fixes, tests
  • Examples: New tutorials, use cases

Pull Request Process

  1. Fork the repository
  2. Create a feature branch
  3. Make changes with tests
  4. Run linting and tests
  5. Submit PR with clear description

Code of Conduct

Be respectful and constructive. We welcome contributors of all experience levels.