Contributing Guide

// ✅ Good
import { ApiService } from '../services/api.js';
import { state } from '../services/state.js';

class VideoPlayer {
    constructor(element) {
        this.element = element;
        this.state = state;
        this.api = ApiService;
    }
    
    async loadVideo(fileId) {
        const url = this.api.getVideoUrl(fileId);
        this.element.src = url;
    }
}

export { VideoPlayer };

// ❌ Bad
var player = $('#video');
player.attr('src', '/video/' + id);

export const MyView = {
    async render() {
        // Return HTML string
        return `
            <div class="my-view">
                <h1>Hello World</h1>
            </div>
        `;
    },
    
    afterRender() {
        // Attach event listeners
        const button = document.querySelector('.my-button');
        button.addEventListener('click', this.handleClick);
    },
    
    cleanup() {
        // Remove listeners, clear timers
        const button = document.querySelector('.my-button');
        if (button) {
            button.removeEventListener('click', this.handleClick);
        }
    },
    
    handleClick(e) {
        console.log('Clicked!');
    }
};

// ✅ Good
async function loadCourses() {
    try {
        const data = await ApiService.fetchCourses();
        state.courses = data;
    } catch (error) {
        console.error('Failed to load courses:', error);
        showErrorMessage('Could not load courses. Please refresh.');
    }
}

// ❌ Bad
async function loadCourses() {
    const data = await ApiService.fetchCourses();
    state.courses = data;
}

# ✅ Good
from typing import Dict, List, Optional
import logging

logger = logging.getLogger(__name__)

def scan_courses(path: str) -> List[Dict]:
    """Scan courses directory and return course data.
    
    Args:
        path: Directory path to scan
        
    Returns:
        List of course dictionaries with metadata
        
    Raises:
        FileNotFoundError: If path does not exist
    """
    try:
        courses = []
        # Implementation...
        return courses
    except FileNotFoundError as e:
        logger.error(f"Directory not found: {path}")
        raise
    except Exception as e:
        logger.error(f"Error scanning courses: {e}")
        return []

# ❌ Bad
def scanCourses(path):
  courses=[]
  # Implementation...
  return courses

from typing import Dict, List, Optional, Tuple

def match_course(
    md_name: str,
    drive_names: Dict[str, str],
    threshold: float = 0.8
) -> Optional[Tuple[str, str]]:
    """Match course name to Drive folder.
    
    Returns:
        Tuple of (folder_name, folder_id) or None if no match
    """
    pass

import logging

logger = logging.getLogger(__name__)

# ✅ Good
logger.info("Starting cache rebuild...")
logger.warning(f"Course not found: {course_name}")
logger.error(f"Drive API error: {error}", exc_info=True)

# ❌ Bad
print("Starting cache rebuild...")

/* Block */
.video-player { }

/* Element */
.video-player__controls { }
.video-player__play-button { }

/* Modifier */
.video-player--fullscreen { }
.video-player__play-button--disabled { }

:root {
    --color-primary: #1A73E8;
    --color-background: #1E1E1E;
    --color-text: #FFFFFF;
    --spacing-unit: 8px;
    --border-radius: 8px;
}

.button {
    background: var(--color-primary);
    padding: calc(var(--spacing-unit) * 2);
    border-radius: var(--border-radius);
}

/* Mobile first (default) */
.grid {
    display: grid;
    grid-template-columns: 1fr;
    gap: 16px;
}

/* Tablet */
@media (min-width: 768px) {
    .grid {
        grid-template-columns: repeat(2, 1fr);
    }
}

/* Desktop */
@media (min-width: 1024px) {
    .grid {
        grid-template-columns: repeat(3, 1fr);
    }
}