How to Contribute

Thank you for your interest in contributing to Helios Engine! This document provides guidelines and information for contributors.

🚀 Quick Start for Contributors

Development Setup

Clone the repository:

git clone https://github.com/Ammar-Alnagar/Helios-Engine.git
cd Helios-Engine

Build the project:
```
cargo build
```
Run tests:
```
cargo test
```
Format code:
```
cargo fmt
```
Check for issues:
```
cargo clippy
```

First Contribution

Fork the repository on GitHub
Create a feature branch: git checkout -b feature/your-feature-name
Make your changes
Run tests: cargo test
Format code: cargo fmt
Check for issues: cargo clippy
Commit your changes: git commit -m "Add your feature"
Push to your fork: git push origin feature/your-feature-name
Create a Pull Request

🏗️ Development Workflow

Branching Strategy

main: Production-ready code
develop: Integration branch for features
feature/*: New features
bugfix/*: Bug fixes
hotfix/*: Critical fixes for production

Commit Messages

Follow conventional commit format:

type(scope): description

[optional body]

[optional footer]

🧪 Testing

Running Tests

# Run all tests
cargo test

# Run specific test
cargo test test_name

📚 Documentation

Documentation Standards

Use Markdown for all documentation
Include code examples where relevant
Provide both conceptual and practical information
Keep documentation up-to-date with code changes
Use clear, concise language accessible to different experience levels