Alpha software, not for production data. Bugs can cause data loss, formats may change without migration, and the cryptography has not been independently audited. Keep your own backups and check that you can restore from them.
Varsto

Contributing

From CONTRIBUTING.md in the repository, rendered 2026-10-12.

Thanks for your interest. Varsto is pre-alpha and the contribution process is still being defined.

Rules that already apply

  • Language: everything in this repository is written in English: code comments, identifiers, commit messages, issues, pull requests and documentation.
  • No personal data. Never commit real personal data, real file names, real device or server names, credentials, keys or addresses. Test fixtures must be invented and generic (for example IMG_0001.jpg, laptop, usb-a, cloud).
  • No secrets. Do not commit credentials, tokens, private keys or recovery phrases.
  • Tests. New behaviour needs tests. See TESTING.md.
  • Security first. Do not implement your own cryptographic primitives. Use reviewed libraries and document every choice.
  • Logging. Never log secrets, keys, file names or paths in clear text. Use the sanctioned logging macros and the secret wrapper types; see docs/architecture/logging.md.
  • One name in one place. The product name lives in brand/brand.toml; do not hard-code it where it can be avoided, because the working name may change.
  • Licence headers. Every source file (Rust, shell, JavaScript, CSS) starts with SPDX-License-Identifier: PolyForm-Shield-1.0.0. Markdown, JSON, YAML and HTML files carry no header.
  • Rust. Stable toolchain (see rust-version in Cargo.toml). cargo fmt --all --check, cargo clippy --workspace --all-targets and cargo test --workspace must pass before a pull request.

Licence of contributions

The project is licensed under the PolyForm Shield License 1.0.0. By contributing you agree that your contribution may be distributed under that licence and relicensed by the project. The exact mechanism (Developer Certificate of Origin sign-off or a Contributor Licence Agreement) is not decided yet; until it is, please open an issue before sending large changes.

Workflow

  1. Create a branch from main.
  2. Keep commits small and described in the imperative mood.
  3. Open a pull request and describe what changed and why.