Skip to content

CONTRIBUTE.md

Latest commit

 

History

History
73 lines (44 loc) · 2.66 KB

CONTRIBUTE.md

File metadata and controls

73 lines (44 loc) · 2.66 KB

Contributing

Requirements

This document will explain how to get started with Vortex development. First, make sure you have these general coding requirements:

Next, you need to install some build tools for Vortex:

  • Volta for Node version management,
  • and the .NET 9 SDK for building .NET projects.

Vortex depends on native Node modules which require node-gyp. You need to install a supported Python version and a C/C++ toolchain:

  • Windows: VS 2022 Build Tools, follow node-gyp documentation for installation instructions
  • Linux: make and GCC (package build-essentails on Debian/Ubuntu and base-devel on Arch Linux)

Starting with Python 3.12 you also need to install the setuptools packages. Verify your version by running python3 --version and install the package through pip or your system's package manager.

Setup

  1. Clone the repository
  2. volta install node@22
  3. npm install --global corepack@latest
  4. corepack install
  5. pnpm install

Developing

  1. pnpm run build:all
  2. pnpm run start

Debugging

VS Code

  • F5 - Debug both main and renderer processes
  • Build first - Always run pnpm run build:all before debugging

See docs/DEBUGGING-GUIDE.md for detailed debugging instructions.

Packaging

Local unsigned packages (Windows)

To create a packaged installer for local testing without code signing:

pnpm run package:local

This downloads the required redistributables (VC++ and .NET Runtime) and creates an unsigned installer in the dist/ directory.

Signed release builds

Signed builds are created automatically via CI. Do not run pnpm run package locally.

FAQ

When will my changes be added to the stable release?

Please see docs/branching-and-release-strategy.md for more information

Further Reading