Skip to content

Contributing

Issues and pull requests are welcome on GitHub.

Make sure CI will be happy:

Terminal window
cargo fmt --all
cargo clippy --all-targets --locked -- -D warnings
cargo test --locked

CI runs fmt and clippy on Linux, then builds and tests on Linux, macOS and Windows.

examples/seed.rs seeds a local path on 127.0.0.1, so you can test without the public swarm:

Terminal window
cargo run --example seed -- ./some-dir # prints magnet + peer address, writes ./some-dir.torrent
cargo run -- serve ./some-dir.torrent --peer 127.0.0.1:<port>
DEADDROP_KEY=<key> cargo run -- fetch <ticket> -o /tmp/out

Debug builds log warnings by default. Use RUST_LOG=deaddrop=debug for more.

Want a new notifier? See Adding a notifier. It’s about two files of work.

deaddrop is free and unencumbered software released into the public domain. See LICENSE or unlicense.org.