Lucas RayanandClaude Sonnet 5.5
b93ad02a0e
README, ROADMAP, CHANGELOG, CONTRIBUTING, SECURITY e docs/ passam a ter a versão principal em inglês. As versões em português ficam em *.pt-BR.md e docs/pt-BR/, com seletor de idioma no topo de cada arquivo. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RRZm8uTVN3WLTwcbrDQAUM
2.3 KiB
Contributing to Guará
Thanks for helping! Golden rules:
- Never write to the source. Any code that opens a device must use
source::open_path(read-only). PRs that write to the source disk are rejected. - Test with real data. New detectors/readers need a test that recovers a known file bit for bit (see
crates/guara-core/tests/andscripts/make-fixtures.sh). - Be honest about confidence. If the content cannot be validated, confidence is at most medium.
Workflow
cargo fmt --all
cargo clippy --workspace --all-targets
cargo test --workspace
On Linux the tests build images with mtools, ntfs-3g, e2fsprogs, exfatprogs, imagemagick, zip and python3. Without these tools the image tests are skipped (set GUARA_REQUIRE_FIXTURES=1 to make them fail).
For the external reference images (BitLocker, FileVault 2, dfvfs, AFF4), run scripts/fetch-testdata.sh; without them those tests are skipped. The BitLocker test takes about 75 s.
Where to make changes
A map of the modules is in docs/architecture.md. What is missing and what is welcome is in the ROADMAP.
Adding a file format
Simple detectors live in crates/guara-core/src/signatures.rs; the newer ones in formats.rs. Add the detector to detect, the first byte to might_start, the extension to category_for_ext/matches_ext and a real file to scripts/make-fixtures.sh with a bit-exactness test.
Adding a file system
Create the reader in crates/guara-core/src/fs/, register it in fs/mod.rs and bring a test with a real or reference image. We do not ship a reader without validation: that is why ReFS and Storage Spaces do not exist yet. Small images without personal data are the best gift you can give the project.
Documentation
The main version is in English and every file has a Portuguese translation (*.pt-BR.md, docs/pt-BR/). No em dashes or en dashes. When you change a feature, update both versions (English and Portuguese) of docs/support.md, the CHANGELOG and, if applicable, the ROADMAP.
Commits
Short messages in the imperative (fix reading of sparse runs in NTFS). One logical change per PR.