Team Onboarding - ENV Platform

Welcome to EthereaVision! 🚀

You're now part of a team building the future of brain-computer interfaces. This guide will help you get up to speed with our workflows, standards, and culture.

🔀 Git Workflow

We follow a feature-branch workflow with PR reviews.

1. Clone & Setup

                            git clone https://github.com/abhisekkumar/ethereal-neura-vision.git
cd ethereal-neura-vision
git checkout main
git pull origin main
                        

2. Create Feature Branch

                            # Branch naming: feature/your-feature-name
git checkout -b feature/add-new-model
git push -u origin feature/add-new-model
                        

Branch prefixes: feature/ fix/ docs/ refactor/

3. Commit & Push

                            # Make your changes, then commit
git add .
git commit -m "feat: add support for Muse 2 headset"
git push origin feature/add-new-model
                        

Commit format: type: description
Types: feat, fix, docs, style, refactor, test, chore

4. Open Pull Request

Go to GitHub and open a PR from your branch to main

Add clear title and description
Link related issues
Request review from team lead
Wait for CI checks to pass

5. Code Review & Merge

Address review comments, then merge once approved

                            # After PR is approved
git checkout main
git pull origin main
git branch -d feature/add-new-model  # cleanup
                        

📝 Code Standards

Python (Backend Services)

Style: Follow PEP 8, use Black formatter
Type hints: Use type annotations for all functions
Docstrings: Google-style docstrings for all public methods
Imports: Organize with isort (stdlib → third-party → local)
Max line length: 100 characters
Testing: Pytest for all new features (min 80% coverage)

                    # Example: Good Python code
from typing import Optional, Dict, Any
import numpy as np
from .models import BrainEncoder

def encode_signal(
    raw_signal: np.ndarray,
    sample_rate: int = 256,
    normalize: bool = True
) -> Dict[str, Any]:
    """Encode raw EEG signal into neural embeddings.
    
    Args:
        raw_signal: Raw EEG data array
        sample_rate: Sampling frequency in Hz
        normalize: Whether to normalize output
        
    Returns:
        Dict containing embeddings and metadata
    """
    # Implementation here
    pass
                

C# (Unity VR Client)

Style: Follow Microsoft C# conventions
Naming: PascalCase for classes/methods, camelCase for variables
Comments: XML documentation for public APIs
Async: Use async/await for network operations
Events: Use Unity Events for decoupled components

                    // Example: Good C# code
public class ImageStreamManager : MonoBehaviour
{
    /// 
    /// Connects to ENV Platform WebSocket stream
    /// 
    /// Session identifier
    public async Task ConnectAsync(string sessionId)
    {
        var uri = new Uri($"ws://localhost:8007/stream/{sessionId}");
        await _webSocket.ConnectAsync(uri, CancellationToken.None);
    }
}
                

✅ Pull Request Checklist

Before submitting your PR:

Code follows style guidelines (Black/isort for Python)
All tests pass locally (pytest)
New tests added for new features
Documentation updated (README, docstrings)
No console errors or warnings
Commits are clean and well-formatted
Branch is up-to-date with main
PR description clearly explains changes

Running Tests

                    # Run all tests
pytest

# Run specific test file
pytest tests/test_brain_encoder.py

# Run with coverage
pytest --cov=services --cov-report=html

# Lint check
black --check .
pylint services/
                

💬 Communication

Stay connected with the team through these channels:

📧 Email

developer@ethereavision.com

For official communications

💬 Slack

#env-development

Daily standup & quick questions

📹 Zoom

Weekly Sync

Mondays 10AM ET

🐙 GitHub

Issue Tracker

Bug reports & feature requests

Response Time Expectations

Urgent (System Down): <1 hour
PR Reviews: Within 24 hours
Slack Messages: Within business day
Email: Within 48 hours

📁 Project Structure

                    ethereal-neura-vision/
├── services/               # 7 microservices
│   ├── neuro_ingest/
│   ├── preprocessing/
│   ├── brain_encoder/
│   ├── semantic_engine/
│   ├── generation/
│   ├── xr_streaming/
│   └── session_orchestrator/
├── unity/                  # Unity VR client
│   └── EtherealNeuraVision-VR/
├── models/                 # Trained ML models
├── tests/                  # Test suites
├── docs/                   # Documentation
├── scripts/                # Utility scripts
├── docker-compose.yml      # Service orchestration
└── README.md
                

🌟 Team Culture & Values

Move Fast, Break Things (Carefully): Iterate quickly in dev, be careful in prod
Documentation First: If it's not documented, it doesn't exist
Ask Questions: No question is too basic. We're all learning
Give Context: Explain the "why" in PRs and commits
Respect Time Zones: Async-first, meetings when necessary
Celebrate Wins: Share progress and successes
Own Your Work: Take responsibility and see things through

🎉 You're Ready!

You've completed onboarding. If you have questions, reach out to the team lead or check the other docs. Welcome aboard! 🚀