Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/adileo/squirreldisk/llms.txt

Use this file to discover all available pages before exploring further.

​
Contributing to SquirrelDisk

SquirrelDisk is an open-source disk space analyzer built with Rust and React. We welcome contributions from developers of all skill levels to help make SquirrelDisk even better!

​
Why Contribute?

SquirrelDisk is licensed under the AGPL-3.0 license, which means:
  • The project is free and open-source
  • Your contributions help users on Windows, macOS, and Linux
  • You’ll gain experience with modern technologies like Rust, Tauri, React, and D3.js
  • You’re part of building a fast, cross-platform alternative to WinDirStat, WizTree, TreeSize, and DaisyDisk
SquirrelDisk is currently in ALPHA status. While the app is functional, you may encounter bugs and the codebase needs refactoring. This is a great opportunity to make a meaningful impact!

​
Ways to Contribute

There are many ways to contribute to SquirrelDisk:

Report Bugs

Found a bug? Report it on our GitHub issue page with detailed explanations and screenshots.

Request Features

Have an idea? Share it on our issue page or discussions.

Write Code

Fix bugs, implement features, or refactor existing code. Check the issues page for tasks to work on.

Improve Docs

Help improve documentation, add examples, or clarify existing content.

​
Code of Conduct

We strive to maintain a welcoming and inclusive community. When contributing:
  • Be respectful and considerate in all interactions
  • Welcome newcomers and help them get started
  • Focus on constructive feedback
  • Respect different viewpoints and experiences

​
GitHub Workflow

Follow these steps to contribute code to SquirrelDisk:
1

Fork the Repository

Fork the SquirrelDisk repository to your GitHub account.
2

Create a Branch

Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-name
Use descriptive branch names like feature/add-sorting, fix/memory-leak, or docs/update-readme.
3

Make Your Changes

Write your code, following the project’s coding style. Make sure to:
  • Test your changes thoroughly
  • Write clear commit messages
  • Keep commits focused and atomic
4

Push to Your Fork

Push your branch to your forked repository:
git push origin feature/your-feature-name
5

Open a Pull Request

Open a pull request from your branch to the main SquirrelDisk repository. Include:
  • A clear description of your changes
  • Screenshots or videos for UI changes
  • References to related issues
6

Address Feedback

Respond to code review feedback and make necessary changes. Once approved, your PR will be merged!

​
Join the Community

Connect with other contributors and users:

Discord Community

Join our Discord server to chat with maintainers, ask questions, and collaborate with other contributors.

​
Next Steps

Development Setup

Set up your local development environment

Architecture

Learn about SquirrelDisk’s architecture and codebase

Build docs developers (and LLMs) love

Get started for freeTalk to us