Skip to content

Latest commit

 

History

History
100 lines (72 loc) · 2.03 KB

File metadata and controls

100 lines (72 loc) · 2.03 KB

Contributing to FileManagerDaz

First off, thank you for considering contributing to FileManagerDaz!

This document provides guidelines and instructions for contributing to this project.

Table of Contents

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally:
    git clone https://github.com/yaniswav/FileManagerDaz.git
    cd FileManagerDaz
  3. Add the upstream remote:
    git remote add upstream https://github.com/yaniswav/FileManagerDaz.git

Development Setup

Prerequisites

Installation

npm install
npm run tauri dev

Useful Commands

Command Description
npm run dev Start Vite dev server only
npm run tauri dev Start full Tauri app in dev mode
npm run build Build frontend for production
npm run tauri build Build complete application
npm run check Run Svelte/TypeScript type checking

Code Style

Rust (Backend)

cd src-tauri
cargo fmt
cargo clippy --all-targets --all-features
cargo check

TypeScript/Svelte (Frontend)

npm run check

Testing

Before Submitting

npm run check
cd src-tauri
cargo check
cargo test

Submitting Changes

  1. Push your branch to your fork
  2. Open a Pull Request against the main branch
  3. Fill out the PR template
  4. Respond to review feedback

PR Requirements

  • All CI checks pass
  • Code follows style guidelines
  • New features have documentation

Thank you for contributing!