Contributing Guidelines and Code Standards

# Make sure your local develop is up to date before branching
git checkout develop
git pull upstream develop

# Create and switch to a new feature branch
git checkout -b feature/amazing

<type>(<scope>): <description>

[optional body]

[optional footer]

# Features
git commit -m "feat(auth): add password reset flow"
git commit -m "feat(trip-planner): add Trip Planner API (/trip_planner/plans)"
git commit -m "feat(superadmin): add endpoints for users, vendors, bookings, tours, audit, content"
git commit -m "feat(monitoring): add Prometheus metrics, structured logging, GZip compression"

# Bug fixes
git commit -m "fix(properties): correct price calculation in booking"
git commit -m "fix(search): correct tours endpoint query params (q, destination, min_duration, sort)"
git commit -m "fix(auth): redirect clients to / instead of /dashboard after login"

# Documentation and chores
git commit -m "docs(api): add examples to search endpoint"
git commit -m "chore(ci): add pre-commit hooks, ruff, vitest, deploy pipeline"
git commit -m "refactor(frontend): simplify booking store"
git commit -m "test(backend): add 10 pagination unit tests and formatNumber edge case tests"

# Check and auto-fix linting issues
ruff check --fix backend/

# Format all Python files
ruff format backend/

# Or run both in one shot via Make
make lint-backend-fix

# Lint all Vue, JS, and TS files
cd frontend && npx eslint . --ext .vue,.js,.ts

# Or via Make
make lint-frontend

# Run all hooks manually before pushing
pre-commit run --all-files

from sqlalchemy.ext.asyncio import AsyncSession
from fastapi import APIRouter, Depends
from app.api import deps

router = APIRouter()

@router.get("/{tour_id}", response_model=TourResponse, summary="Get a tour by ID")
async def get_tour(
    tour_id: int,
    db: AsyncSession = Depends(deps.get_db),
    current_user: User = Depends(deps.get_current_user),
) -> TourResponse:
    """Return a single tour record.

    - **tour_id**: The integer primary key of the tour
    - Returns: Full tour detail with availability and vendor info
    """
    service = TourService(db)
    return await service.get_by_id(tour_id)

from pydantic import BaseModel, Field
from datetime import datetime

class TourCreate(BaseModel):
    title: str = Field(..., min_length=3, max_length=255)
    duration_hours: int = Field(..., ge=1)
    price_usd: float = Field(..., gt=0)

class TourResponse(BaseModel):
    id: int
    title: str
    duration_hours: int
    price_usd: float
    created_at: datetime

    model_config = {"from_attributes": True}

from app.core.logging import get_logger

logger = get_logger(__name__)

async def process_booking(booking_id: int) -> None:
    logger.info("Processing booking", extra={"booking_id": booking_id})

@router.post(
    "/",
    response_model=TourResponse,
    status_code=201,
    summary="Create a new tour",
    description="Creates a new tour listing for the authenticated vendor. Requires the `vendor` role.",
    tags=["Tours"],
)
async def create_tour(...):
    ...

<script setup lang="ts">
import { ref, computed } from 'vue'
import type { Tour } from '~/types'

interface Props {
  tours: Tour[]
  loading?: boolean
}

const props = defineProps<Props>()
const emit = defineEmits<{ select: [tour: Tour] }>()

const selected = ref<Tour | null>(null)
const hasTours = computed(() => props.tours.length > 0)

const handleSelect = (tour: Tour) => {
  selected.value = tour
  emit('select', tour)
}
</script>

// stores/tourStore.ts
import { defineStore } from 'pinia'
import { ref } from 'vue'
import type { Tour } from '~/types'

export const useTourStore = defineStore('tour', () => {
  const tours = ref<Tour[]>([])
  const loading = ref(false)

  async function fetchTours() {
    loading.value = true
    try {
      tours.value = await $fetch('/api/v1/tours')
    } finally {
      loading.value = false
    }
  }

  return { tours, loading, fetchTours }
})

<template>
  <p>{{ $t('tours.noResults') }}</p>
</template>

// In a composable
const { t } = useI18n()
const label = t('filters.minRating')