Skip to main content
Sparkle is an open-source project and contributions of all kinds are welcome. Whether you want to fix a bug, add a new tweak, improve the docs, or suggest a feature, this guide explains how to get involved.
Sparkle is currently in beta. Always back up your system before applying tweaks, and test your changes thoroughly before submitting a pull request.

​
Ways to contribute

Report bugs

Open an issue on GitHub with your Sparkle version, Windows version, log file, steps to reproduce, and the expected vs. actual behavior. Logs are located at C:\Users\YOUR_USER\AppData\Roaming\sparkle\logs.

Submit pull requests

Fork the repository, create a branch, make and test your changes, then open a pull request with a clear description of what you changed and why.

Add tweaks

Write a PowerShell script and a meta.json to add a new optimization tweak. See the creating tweaks guide for the full spec.

Add apps

Add an entry to apps.json to make a new application available in the Sparkle app installer. See the adding apps guide.

Improve documentation

Fix typos, expand explanations, or add missing content. Documentation lives in the docs/ directory of the repository.

Enhance UI/UX

Improve the look or usability of the Electron front-end. Sparkle is built with React and TypeScript.

​
Development setup

​
Prerequisites

  • Node.js v22 or higher
  • Windows 10 or 11 (required — some features only work on Windows)
Running Sparkle in development mode with administrator privileges is recommended. Some tweaks and features require elevated permissions to function correctly.

​
Run Sparkle locally

1

Fork and clone the repository

Fork the repository on GitHub, then clone your fork:
git clone https://github.com/parcoil/sparkle.git
cd sparkle
2

Install dependencies

npm install
3

Start development mode

npm run dev
This launches Sparkle with hot reload enabled for both the Electron main process and the renderer process.
4

Build for production

When you are ready to produce a distributable build, run:
npm run build
This generates optimized production builds in the dist/ directory.

​
Community

Join the conversation and get help from other contributors:

Build docs developers (and LLMs) love

Get started for freeTalk to us