Contributing

Pull Requests

Name pull requests using the imperative mood (i.e. "Add feature", or "Fix bug").
Each pull request should focus on a single, clear change.
All pull requests are squashed and merged, so ensure your pull request accurately summarizes the change.

This project uses ESLint and Prettier for linting and formatting.

You can lint and format your code by running:

make lint-fix

Copy .env.template to .env and set any necessary environment variables which will be loaded in the Makefile.

cp .env.template .env

Important

GNOME Shell 49 and above requires mutter-devkit to be installed to run a GNOME Shell instance.

Install Mutter Devkit

Distro	Command
Fedora	`sudo dnf install mutter-devel`
Arch Linux	`sudo pacman -S mutter-devkit`
Ubuntu/Debian	`sudo apt install mutter-dev-bin`
openSUSE	`sudo zypper install mutter-devel`

Install the extension and run a nested GNOME Shell instance for development and testing.

make launch

Install the extension and launch extension settings while also observing gjs/gnome-shell logs and dconf changes.

make launch-settings