Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (71 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

94 lines (71 loc) · 1.67 KB

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)
curl https://instl.vercel.app/go-task/task | bash

PowerShell/cmd.exe

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

Initial Setup

  1. Clone the repository:
git clone https://github.com/tgdrive/teldrive.git
cd teldrive
  1. Install dependencies:
task deps

Building TelDrive

Complete Build

To build both frontend and backend:

task

Frontend Development

The frontend is managed in a separate repository (teldrive-ui). The main repository pulls the latest frontend release during build.

To set up the frontend:

task ui

Backend Development

To build the backend only:

task server

Running TelDrive

After building, run the application:

task run

Feature Development

  1. Create a new branch for your feature:
git checkout -b feature/your-feature-name
  1. Generate API Spec:
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