Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.56 KB

Contributing

Thank you for considering a contribution to NEXUS-Q Vault.

Before you start

Development

  • Rust 1.90 or newer for the desktop application (the library crate declares Rust 1.88).
  • Keep the cryptographic boundary narrow: all cryptographic operations belong to the reviewed nexusq-core API.
  • Run cargo fmt --check, cargo clippy --all-targets -- -D warnings, and cargo test before submitting.
  • Add tests for failure cases, corruption and interrupted operations.
  • Never commit credentials, real user files, recovery phrases or key material.

Pull requests

A pull request should explain the user impact, security impact, tests performed, format compatibility impact and any migration implications. Changes to key handling, file formats, recovery, backups, dependencies or update verification must be explicitly marked security-sensitive.

Security review

Security-sensitive changes require approval from designated maintainers before merge. Until a security-maintainer group and independent reviewers are formally appointed, the project must not claim that such review has occurred. Do not disclose vulnerabilities in public issues; follow SECURITY.md.

License

By submitting a contribution, you agree that it is offered under the project's MIT license. Include attribution and license notices for third-party material.