Contributing Guide

// Explicit types, clear naming
interface UserProfile {
  id: string;
  email: string;
  name: string;
  createdAt: Date;
}

const fetchUserProfile = async (userId: string): Promise<UserProfile> => {
  const response = await fetch(`/api/users/${userId}`);

  if (!response.ok) {
    throw new Error('Failed to fetch user profile');
  }

  return response.json();
};

// Implicit any, unclear naming
const getData = async (id) => {
  const res = await fetch(`/api/users/${id}`);
  return res.json();
};

// Typed props, clear structure
interface ButtonProps {
  label: string;
  onClick: () => void;
  variant?: 'primary' | 'secondary';
  disabled?: boolean;
}

export const Button = ({
  label,
  onClick,
  variant = 'primary',
  disabled = false
}: ButtonProps) => {
  return (
    <button
      onClick={onClick}
      disabled={disabled}
      className={`btn btn-${variant}`}
    >
      {label}
    </button>
  );
};

// No types, unclear props
export const Button = (props) => {
  return <button onClick={props.onClick}>{props.children}</button>;
};

// Default in Next.js 15 - No "use client" directive
// Can fetch data directly
import { getGuestDisruptions } from '@/app/actions/guest-disruptions';

export default async function GuestDisruptionsPage() {
  const disruptions = await getGuestDisruptions();

  return <GuestDisruptionsTable data={disruptions} />;
}

// Use "use client" for interactivity
'use client';

import { useState } from 'react';

export const InteractiveTable = ({ data }) => {
  const [selected, setSelected] = useState<string[]>([]);
  // ... interactive logic
};

// Comprehensive error handling
try {
  const result = await fetchData();
  return { success: true, data: result };
} catch (error) {
  console.error('API call failed:', error);
  return {
    success: false,
    error: error instanceof Error ? error.message : 'Unknown error'
  };
}

// Swallowing errors
try {
  return await fetchData();
} catch (e) {
  console.log(e);
}

// Explains WHY, not WHAT
// Fetch disruptions in parallel to avoid waterfall requests
const [disruptions, pathways] = await Promise.all([
  getGuestDisruptions(),
  getAlternativePathways(),
]);

// States the obvious
// Call getGuestDisruptions function
const disruptions = await getGuestDisruptions();