Contributing to Sparkle¶

Thank you for your interest in contributing to Sparkle! This guide covers the different ways you can help improve the project.

Ways to Contribute¶

Reporting Issues¶

Found a bug or have a feature request? Open an issue on GitHub.

When reporting bugs, include:

• Sparkle version
• Windows version
• Log file (Located at C:\Users\YOUR_USER\AppData\Roaming\sparkle\logs)
• Steps to reproduce
• Expected vs actual behavior

Pull Requests¶

We welcome pull requests. To get started:

1. Fork the repository
2. Create a new branch for your changes
3. Make your changes and test them
4. Submit a pull request with a clear description

Adding New Apps¶

You can add new applications to the Sparkle app installer by editing the apps.json file.

See the full guide: Contributing New Apps

Creating Tweaks¶

Want to add a new tweak? Tweaks use PowerShell scripts and a meta.json configuration file.

See the full guide: Creating Tweaks

Development Setup¶

To run Sparkle locally:

# Clone the repository
git clone https://github.com/parcoil/sparkle.git
cd sparkle

# Install dependencies
npm install

# Start development mode (Admin Recomended. Some things only work with admin)
npm run dev

Community¶

• GitHub Repository
• Discord Server