Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (57 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

82 lines (57 loc) · 2.43 KB
Raw

Contributing to MangoFetch CLI

Thanks for taking the time to contribute.

Prerequisites

  • Rust 1.70+ (stable toolchain)
  • Git

No Node.js, pnpm, or frontend tooling is required for CLI development.

Building the CLI

git clone https://github.com/julesklord/mangofetch-cli.git
cd mangofetch-cli
cargo build -p mangofetch-cli

Run the CLI directly during development:

cargo run -p mangofetch-cli -- --help
cargo run -p mangofetch-cli -- check
cargo run -p mangofetch-cli -- download https://example.com/video

Build a release binary:

cargo build -p mangofetch-cli --release

The binary will be at target/release/mangofetch-cli (or mangofetch-cli.exe on Windows).

Project structure

mangofetch-cli/        # CLI binary crate (clap + indicatif)
│   └── src/
│       ├── main.rs     # Command definitions and dispatch
│       └── reporter.rs # CLI progress bar reporter
mangofetch-core/       # Shared library crate
│   └── src/
│       ├── core/       # Download engine, dependencies, HTTP client, yt-dlp integration
│       │   ├── manager/    # Queue, recovery, download log
│       │   ├── traits.rs   # DownloadReporter trait
│       │   └── ...
│       └── models/     # Data structures (queue items, settings)
└── mangofetch-lib/        # Platform implementations (YouTube, Instagram, etc.)

Before opening a pull request

Run these checks locally:

cargo fmt --all
cargo clippy --workspace --all-targets
cargo test --workspace

All three must pass cleanly before submitting.

What to work on

  • Bug fixes: If you find a bug, open an issue first, then submit a fix.
  • New platforms: Add a new downloader in mangofetch-core/src/platforms/ implementing the PlatformDownloader trait.
  • Core improvements: Enhancements to the download queue, progress reporting, or dependency management in mangofetch-core.
  • Documentation: Improvements to README, inline docs, or usage examples.

Commit style

Follow Conventional Commits: feat:, fix:, refactor:, docs:, chore:. Keep the subject under 72 characters.

Security issues

Do not file public issues for security problems. See SECURITY.md.

License

By contributing you agree that your changes are licensed under GPL-3.0.