Contribution Guide
Thanks for contributing to HeelonVault.
Getting started
Section titled “Getting started”Prerequisites, build, tests and quality gates are described in the development guide. The internals are covered in ARCHITECTURE.en.md.
Building the workspace currently requires the private
heelonvault-premiumrepository checked out next to this one (see the development guide). Documentation fixes and changes confined to theheelonvault-corecrate can still be checked withcargo test -p heelonvault-corefrom a standalone copy of that crate.
Code standards
Section titled “Code standards”- Follow the existing style, naming and module layout.
- No
unwrap()/expect()(banned byclippy.toml), nounsafe, no warning: CI builds with-D warnings. Use typed errors (thiserror). - No
#[allow(...)]to silence a lint without a written rationale. - Never let a secret value reach the UI layer, a log or an error message.
- Add tests for repository and service behaviour changes
(
crates/heelonvault-core/tests/). - Changes to the public API of
heelonvault-corefollow semver: prefer default trait methods,#[non_exhaustive]and deprecation over breaking changes (RELEASING.en.md). - Prefer small, focused commits. Do not commit secrets or personal data.
Pull request checklist
Section titled “Pull request checklist”- The quality gates of the development guide pass (
fmt,clippy,test,semver-checks). sbom.cyclonedx.jsonis regenerated if dependencies changed.- User-visible changes are reflected in the changelog (FR and EN) and in the relevant guide
(
docs/QUICKSTART*,docs/USER_GUIDE*,docs/UPDATE_GUIDE*). - Security-sensitive changes are justified in the PR description.
Documentation
Section titled “Documentation”docs/ is published on doc.heelonvault.heelonys.fr;
docs/internal/ is for maintainers and is not published. Keep both languages in sync.
Security reports
Section titled “Security reports”Do not open a public issue for security vulnerabilities: see SECURITY.md.
Contact: security@heelonys.fr
