mirror of
https://github.com/TimInTech/proxmox-manager.git
synced 2026-11-20 19:22:53 +03:00
1.6 KiB
1.6 KiB
Contributing Guide
Thanks for your interest in improving proxmox-manager!
How to Contribute
-
Discuss first Open an issue before starting major work so we can align on scope, approach, and ownership.
-
Fork and branch Create a topic branch from
main. Use descriptive branch names such asfeature/json-outputorfix/spice-port. -
Style and tooling
- Shell scripts must pass
shellcheckandshfmt -w -i 2 -ci -sr. - Markdown should be wrapped at 100 columns when practical.
- Follow the
.editorconfigsettings.
- Shell scripts must pass
-
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.shandpython3 -B -m unittest discover -s tests/maintenance -vlocally. - Add regression coverage to the existing test harnesses for behavior changes.
- Document manual testing steps in the pull request description.
-
Commit standards
- Keep commits focused and atomic.
- Reference GitHub issues using
Fixes #123when applicable.
-
Pull Request checklist
./install_dependencies.shran successfully (if relevant).shellcheckandshfmtpass 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.