Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
93 lines (58 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

93 lines (58 loc) · 2.51 KB
Raw

Contributing

Thank you for your interest in contributing to the SweenLab Proxmox Scripts project!

Whether you're reporting a bug, suggesting a feature, improving documentation, or submitting code, your help is appreciated.

Ways to Contribute

You can contribute by:

  • Reporting bugs
  • Suggesting new features
  • Improving documentation
  • Fixing typos
  • Improving existing scripts
  • Creating new Proxmox-related utilities

Before Opening an Issue

Please check existing Issues to avoid creating duplicates.

When reporting a bug, include:

  • Proxmox VE version
  • Operating system version
  • Script name and version
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Any error messages or logs

Feature Requests

Feature requests are always welcome.

When suggesting a new feature, please describe:

  • The problem you're trying to solve
  • Your proposed solution
  • Any alternatives you've considered

The more detail you provide, the easier it is to evaluate the request.

Pull Requests

Before submitting a pull request:

  • Test your changes thoroughly.
  • Keep commits focused on a single change whenever possible.
  • Update documentation if your changes affect behavior.
  • Follow the existing coding style used throughout the project.

Large changes should generally be discussed in an Issue before implementation.

Coding Style

Please follow the existing project style:

  • Bash
  • Clear variable names
  • Helpful comments where appropriate
  • Interactive terminal menus with the embedded Python curses UI (Back/Abort navigation; no external UI file)
  • Conservative defaults
  • Safety before automation
  • User-friendly output

Consistency across scripts helps keep the toolkit easy to learn and maintain.

Questions

If you're unsure about an idea, feel free to open a Discussion or Issue before starting work.

Thank you for helping improve the SweenLab Proxmox Scripts project!

Release History

Every user-visible tweak or update gets a new version, an entry in CHANGELOG.md, and a GitHub release. This includes documentation-only updates. Changes for one user request can share a release.

Debian wizard releases use debian-lxc-vX.Y.Z tags to distinguish them from historical maintenance-tool releases. Keep the script version and documentation consistent. Release notes describe the changes, validation, known testing limitations, and the exact one-line launcher. See AGENTS.md for the publishing convention.