Contributing

We welcome contributions to SurrealEngine!

Getting Started

  1. Fork the repository

  2. Clone your fork

  3. Create a feature branch

  4. Make your changes

  5. Run tests

  6. Submit a pull request

Development Setup

git clone https://github.com/YOUR_USERNAME/surrealengine.git
cd surrealengine
python -m venv venv
source venv/bin/activate
pip install -e ".[dev]"

Running Tests

pytest tests/

Guidelines

  • Follow PEP 8 style guide

  • Add tests for new features

  • Update documentation

  • Write clear commit messages

For more details, see the CONTRIBUTING.md file in the repository.