Contributing

Contributions to intel-undervolt are welcome. This document provides a brief guide for developers.

Development Setup

Setting up a development environment is the same as the source installation process. You will need the build essentials like gcc, make, and pkg-config.

  1. Clone the repository: 

    git clone https://github.com/kitsunyan/intel-undervolt.git
cd intel-undervolt

  2. Run the configure script with any features you want to test: 

    ./configure --enable-systemd

Building and Testing

To compile the code after making changes, simply run make from the project root:

make

This will create an intel-undervolt executable in the current directory. You can test your changes by running this local binary directly:

sudo ./intel-undervolt read

To clean all build artifacts, run:

make clean

Reporting Issues

If you encounter a bug or have a feature request, please submit an issue on the GitHub repository.

When reporting a bug, please include:

  • Your CPU model.
  • Your operating system and kernel version.
  • The contents of your /etc/intel-undervolt.conf.
  • Steps to reproduce the issue.
  • Any relevant error messages or logs.

License

This project is licensed under the GNU General Public License v3.0. Please see the COPYING file for the full license text.