Files
vmailctl/CONTRIBUTING.md

1.3 KiB

Contributing

Bug reports, documentation corrections, portability findings, tests and focused patches are welcome through https://git.sdf.org/erici/vmailctl/issues.

Before proposing a code change:

  1. Explain the Postfix/Dovecot layout it addresses.
  2. Avoid broadening the parser without fixtures for the new format.
  3. Preserve the non-destructive and fail-closed behaviour.
  4. Add or update tests.
  5. Run make check and, when available, make man-check.
  6. Do not include real domains, addresses, passwords, hashes, logs or private server configuration.

Release maintainers should create an annotated version tag before running make dist. The target archives the tag corresponding to the executable's version and writes a SHA-256 checksum beside the resulting archive.

Changes affecting transactions, rollback, password handling, ownership, path validation or command execution require particular care and should include failure-path tests.

The project was developed with AI assistance. Contributions produced with substantial automated assistance are acceptable when that assistance is disclosed, the contributor understands the change, and the result has been carefully reviewed and tested. Raw, unreviewed generated patches are not useful.

By contributing, you agree that your contribution may be distributed under GPL-3.0-or-later.