Skip to content

Latest commit

 

History

History
87 lines (55 loc) · 1.83 KB

File metadata and controls

87 lines (55 loc) · 1.83 KB

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 menus using whiptail
  • 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!