Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (57 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

75 lines (57 loc) · 2.29 KB

Contributing to KVitals

Thanks for your interest in contributing! Here's how to get started.

Development Setup

  1. Clone the repo

    git clone https://github.com/yassine20011/kvitals.git
cd kvitals

  2. Install the widget locally

    bash install.sh

  3. Test changes — After editing QML files, reinstall:

    bash install.sh

    Then restart the widget (remove & re-add to panel) or log out / log in.

Project Structure

kvitals/
├── metadata.json                  # Plugin metadata (version, name, etc.)
├── contents/
│   ├── ui/
│   │   ├── main.qml               # Main widget UI
│   │   └── configGeneral.qml      # Settings page
│   ├── config/
│   │   └── config.qml             # Config entry point
├── install.sh                     # Local install script
├── install-remote.sh              # Remote install (curl/wget)
└── package.sh                     # Build .plasmoid package

Commit Messages

Use conventional commit prefixes:

  • feat: — New feature (e.g. feat: add GPU temperature monitoring)
  • fix: — Bug fix (e.g. fix: handle missing thermal zones)
  • docs: — Documentation only (e.g. docs: update install instructions)
  • refactor: — Code restructuring without behavior change
  • chore: — Build scripts, CI, tooling

Submitting a Pull Request

  1. Fork the repo and create a branch: git checkout -b feat/my-feature
  2. Make your changes and test locally on Plasma 6
  3. Commit with a clear message following the conventions above
  4. Push and open a PR against master
  5. In the PR description, mention:
    • What the change does
    • Your Plasma version and distro
    • Screenshots if it's a visual change

Reporting Bugs

Please use the bug report template and include:

  • Your Plasma version (plasmashell --version)
  • Your distro and version
  • Steps to reproduce
  • Expected vs actual behavior

Feature Requests

Use the feature request template.

License

By contributing, you agree that your contributions will be licensed under the GPL-3.0 License.