Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (34 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

48 lines (34 loc) · 1.67 KB
Raw

Contributing to Vib Mail

Vib Mail welcomes focused, tested and backward-compatible contributions.

Non-negotiable preservation rule

  • Do not remove, disable or silently simplify an existing feature.
  • Do not rewrite migration history.
  • Do not change mail-flow or authorization behavior without tests and explicit review.
  • Preserve existing configuration defaults and documented legacy compatibility.

Development setup

cd mailbox-app
python3.12 -m venv .venv
. .venv/bin/activate
pip install -r requirements/development.txt

Required local gates

From the repository root:

python scripts/check_docs.py
python scripts/validate_templates.py
python scripts/test_installer.py
python scripts/test_operations.py
python scripts/forensic_audit.py --root . --full

The full gate runs tests, coverage, Ruff, Bandit, Django checks, contact-service tests and source-safety checks.

Pull requests

  1. Open an issue for significant behavior, schema or deployment changes.
  2. Keep changes narrow and explain compatibility impact.
  3. Add or update tests for every behavior change.
  4. Update documentation, changelog and release notes where applicable.
  5. Do not commit secrets, real mailbox data, personal email addresses, certificates, databases, logs, archives or generated credentials.
  6. Confirm the pull-request checklist and CI results.

Coding standards

Follow docs/CODING_STANDARDS.md. New Python must support Python 3.12 and pass the configured Ruff and Bandit rules. Shell changes must use fail-closed practices and pass bash -n plus installer/operations contract tests.

By contributing, you agree that your contribution is licensed under AGPL-3.0-or-later.