Skip to content

CONTRIBUTING.md

Latest commit

聽

History

History
68 lines (47 loc) 路 1.68 KB

CONTRIBUTING.md

File metadata and controls

68 lines (47 loc) 路 1.68 KB
Raw

Contributing to dirsizes

Thank you for considering contributing to dirsizes! We welcome contributions from the community to help make this tool even better.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue on GitHub with:

  • A clear description of the problem
  • Steps to reproduce the issue
  • Expected vs. actual behavior
  • Your operating system and Rust version

Suggesting Features

We're open to new ideas! Please open an issue describing:

  • The feature you'd like to see
  • Why it would be useful
  • How it might work

Submitting Pull Requests

  1. Fork the repository and create a new branch from main
  2. Make your changes with clear, descriptive commit messages
  3. Test your changes thoroughly
  4. Update documentation if needed (README, code comments)
  5. Submit a pull request with a clear description of your changes

Development Setup

# Clone your fork
git clone https://github.com/YOUR_USERNAME/scanFiles
cd scanFiles

# Create a new branch
git checkout -b feature/your-feature-name

# Make changes and test
cargo build
cargo test

# Build in release mode to test performance
cargo build --release

Code Style

  • Follow standard Rust formatting (cargo fmt)
  • Run cargo clippy to catch common mistakes
  • Write clear, self-documenting code with comments where needed
  • Keep functions focused and modular

Testing

Before submitting a PR:

  • Ensure the code compiles without warnings
  • Test on your target platform(s)
  • Verify the tool works correctly with various directory structures

Questions?

Feel free to open an issue for any questions or clarifications!

Thank you for helping improve dirsizes! 馃殌