Contributing

Thank you for your interest in contributing to Sand Framework! This guide will help you get started.

Contact

For all inquiries, feature requests, and discussions, please reach out via Twitter:

• @0xtuareg

Getting Started

1. Fork the repository

2. Create a feature branch

3. Make your changes

4. Submit a pull request

Development Setup

# Clone your fork
git clone <your-fork-url>
cd sand-framework

# Set up development environment
python -m venv venv
source venv/bin/activate  # or `venv\Scripts\activate` on Windows
pip install -r requirements.txt
pip install -r requirements-dev.txt

# Install pre-commit hooks
pre-commit install

Code Standards

Python

• Follow PEP 8

• Use type hints

• Write docstrings

• Add unit tests

Documentation

• Clear and concise

• Include examples

• Keep up-to-date

• Use proper markdown

Pull Request Process

1. Branch Naming

   feature/description
   fix/issue-description
   docs/update-section

2. Commit Messages

   feat: add new analytics feature
   fix: resolve memory leak in AI service
   docs: update installation guide

3. Testing

   # Run tests
   pytest tests/
   
   # Check code style
   black .
   flake8

4. Documentation

   • Update relevant docs

   • Add inline comments

   • Update changelog

Feature Requests

Have an idea for a new feature? Contact @0xtuareg on Twitter to discuss it!

Please make sure to check existing issues and discussions before proposing new features.