Contributing to vortex

First off, thanks for considering contributing! Every contribution matters, whether it's a bug report, a feature request, or a pull request.

How to Contribute

Reporting Bugs

1. Check if the bug has already been reported in Issues
2. If not, create a new issue using the Bug Report template
3. Include steps to reproduce, expected behavior, and actual behavior

Suggesting Features

1. Check existing Feature Requests
2. Open a new issue using the Feature Request template
3. Describe the problem and your proposed solution

Pull Requests

1. Fork the repository
2. Create a feature branch (git checkout -b feat/your-feature)
3. Make your changes following the project's coding standards
4. Write or update tests as needed
5. Commit using Conventional Commits format
6. Push to your fork and open a Pull Request

Commit Message Format

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

[optional body]

Types: feat, fix, docs, style, refactor, perf, test, chore, ci

Development Setup

Prerequisites

• Rust (stable)
• Node.js >= 22
• Linux: libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev patchelf
• Optional: Nix for reproducible environment (nix develop)

Getting Started

git clone https://github.com/mpiton/vortex.git
cd vortex
npm install          # installs deps + sets up lefthook git hooks
npm run tauri dev    # starts dev server with hot reload

Running Tests

cargo test --manifest-path src-tauri/Cargo.toml --workspace   # Rust tests
npm test                                                       # TypeScript tests
npm run typecheck                                              # Type checking

Linting

cargo fmt --manifest-path src-tauri/Cargo.toml --check        # Rust formatting
cargo clippy --manifest-path src-tauri/Cargo.toml -- -D warnings  # Rust linting
npx oxlint .                                                   # TypeScript linting

Code of Conduct

This project follows a Code of Conduct. By participating, you agree to uphold it.

Questions?

Open a Discussion or file an issue using the Question template.