CONTRIBUTE.md

Contributing

Recommended editor: VS Code with workspace extensions. You will be prompted to install them when you first open the repo.

Requirements

Before you start, make sure you have:

• A GitHub account for creating pull requests,
• The git CLI or a GUI client such as GitHub Desktop,
• An editor with TypeScript support such as VS Code download, WebStorm or Neovim.

Setup

1. Install distro-specific prerequisites:

   • Windows setup
   • Linux:
     • Arch-based setup (Arch, CachyOS, Manjaro)
     • Debian-based setup (Debian, Ubuntu, Pop!_OS, Linux Mint)
     • Fedora setup
     • NixOS setup
   • If your distribution is not listed, try Generic Installation Instructions.

2. Continue with Shared Setup.

Developing

After you have finished the setup steps:

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

Debugging

VS Code

• F5 debugs both main and renderer processes
• Build first by running pnpm run build:all before debugging

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

Packaging

• Windows packaging
• Flatpak packaging

FAQ

When will my changes be added to the stable release?

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

Further Reading

• Debugging
• Docker Dev Containers