teldrive/CONTRIBUTING.md

# Contributing to TelDrive

This guide will help you get started with contributing to TelDrive.

## Development Setup

### Prerequisites

- Go (1.22 or later)
- Git
- Task
- PowerShell (for Windows) or Bash (for Unix-like systems)

### Install Task

##### macOS/Linux (curl)
```sh
curl https://instl.vercel.app/go-task/task | bash
```

#### PowerShell/cmd.exe
```powershell
powershell -c "irm https://instl.vercel.app/go-task/task?platform=windows|iex"
```

### Initial Setup

1. Clone the repository:
```bash
git clone https://github.com/tgdrive/teldrive.git
cd teldrive
```

2. Install dependencies:
```bash
task deps
```

## Building TelDrive

### Complete Build
To build both frontend and backend:
```bash
task
```

### Frontend Development
The frontend is managed in a separate repository ([teldrive-ui](https://github.com/tgdrive/teldrive-ui)). The main repository pulls the latest frontend release during build.

To set up the frontend:
```bash
task ui
```

### Backend Development
To build the backend only:
```bash
task server
```

### Running TelDrive
After building, run the application:
```bash
task run
```

## Feature Development

1. Create a new branch for your feature:
```bash
git checkout -b feature/your-feature-name
```

2. Generate API Spec:
```bash
task gen
```

## Pull Request Guidelines

1. **Branch Naming**:
   - `feature/` for new features
   - `fix/` for bug fixes
   - `docs/` for documentation changes
   - `refactor/` for code refactoring

2. **Commit Messages**:
   - Use clear, descriptive commit messages
   - Reference issues when applicable

3. **Pull Request Description**:
   - Describe the changes made
   - Include any relevant issue numbers
   - List any breaking changes