Files

1.6 KiB

Contributing Guide

Thanks for your interest in improving proxmox-manager!

How to Contribute

  1. Discuss first Open an issue before starting major work so we can align on scope, approach, and ownership.

  2. Fork and branch Create a topic branch from main. Use descriptive branch names such as feature/json-output or fix/spice-port.

  3. Style and tooling

    • Shell scripts must pass shellcheck and shfmt -w -i 2 -ci -sr.
    • Markdown should be wrapped at 100 columns when practical.
    • Follow the .editorconfig settings.
  4. Testing

    • Exercise the script on a Proxmox test host or mock environment when possible.
    • Run bash tests/run.sh, bash tests/test_inventory.sh, bash tests/test_spice.sh and python3 -B -m unittest discover -s tests/maintenance -v locally.
    • Add regression coverage to the existing test harnesses for behavior changes.
    • Document manual testing steps in the pull request description.
  5. Commit standards

    • Keep commits focused and atomic.
    • Reference GitHub issues using Fixes #123 when applicable.
  6. Pull Request checklist

    • ./install_dependencies.sh ran successfully (if relevant).
    • shellcheck and shfmt pass locally.
    • Documentation updated for behavior changes (README.md, docs/).
    • Security scans run locally if you touched sensitive areas; do not commit generated reports.

Releasing

Tag vX.Y.Z on main when a new version is ready. Releases are published from main; there is no automated release-drafter workflow in this repo.