Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (24 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

33 lines (24 loc) · 1.27 KB

Contributing to PROXMUX Manager

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to PROXMUX Manager. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Reporting Bugs

  • Check the FAQ: See if your problem is already covered.
  • Search for existing issues: You might find that your bug has already been reported.
  • Open a new issue: Clearly describe the problem, including steps to reproduce, expected behavior, and actual results.

Suggesting Enhancements

  • Open an issue: Describe your idea and why it would be useful for the project.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. Ensure your code follows the existing style.
  3. Write clear commit messages.
  4. Link to the issue your PR is addressing.

Development Setup

  1. Clone the repository.
  2. Run npm install (if applicable).
  3. Load the extension in Chrome via chrome://extensions/ -> "Load unpacked".

Style Guide

  • Use 4 spaces for indentation.
  • Follow standard JavaScript ES6+ conventions.
  • Keep UI consistent with the existing minimalist, professional design.

Thank you! ❤️