# Contributing Guide Welcome to the Whales Identification project! This guide will help you get started with contributing. --- ## Table of Contents - [Getting Started](#getting-started) - [Development Workflow](#development-workflow) - [Code Style](#code-style) - [Pre-commit Hooks](#pre-commit-hooks) - [Testing](#testing) - [Pull Request Process](#pull-request-process) - [Code Review Guidelines](#code-review-guidelines) - [Common Tasks](#common-tasks) --- ## Getting Started ### Prerequisites - Python 3.11.6 - Node.js ≥20.19 - Docker & Docker Compose - Git - Poetry - Text editor (VS Code, PyCharm, etc.) ### Initial Setup #### 1. Fork and Clone ```bash # Fork on GitHub first, then clone git clone https://github.com/YOUR_USERNAME/whales-identification.git cd whales-identification # Add upstream remote git remote add upstream https://github.com/0x0000dead/whales-identification.git ``` #### 2. Backend Setup ```bash cd whales_be_service # Install Poetry (if not installed) pip install poetry # Install dependencies poetry install # Install pre-commit hooks poetry run pre-commit install # Verify installation poetry run pytest --version ``` #### 3. Frontend Setup ```bash cd frontend # Install dependencies npm install # Verify npm run dev ``` #### 4. Download Models ```bash # From project root pip install huggingface_hub==0.20.3 ./scripts/download_models.sh ``` #### 5. Verify Setup ```bash # Run tests cd whales_be_service poetry run pytest # Start services cd .. docker compose up --build ``` --- ## Development Workflow ### Git Workflow We use **Feature Branch Workflow** with the following conventions: #### Branch Naming ``` / Types: - feature/ - New features - fix/ - Bug fixes - docs/ - Documentation changes - refactor/ - Code refactoring - test/ - Test additions/fixes - chore/ - Maintenance tasks Examples: - feature/add-orca-detection - fix/login-bug - docs/update-api-reference - refactor/optimize-inference ``` #### Commit Messages Follow **Conventional Commits:** ``` ():