Contributing & Debugging

Contributing

For contributing rules & guidelines, see CONTRIBUTING.md

Debugging with VS Code (Recommended)

Install Xephyr.

Arch

sudo pacman -S xorg-server-xephyr

open a terminal window and start Xephyr with

Xephyr -br -ac -noreset -screen 1280x720 :1 &

Xephyr should open a nested Xorg session on display :1.

Now, copy the .vscode folder from /examples into the base hypr folder.

Restart VS Code.

Select the Debug configuration and hit build.

Now, go into the debugging tab, and launch the configured (gdb) Launch setting.

Hypr should now start in the nested Xorg session in the Xephyr window.

Afterword for debugging and cotributing.

Please remember to thoroughly bugtest and check your code if you are contributing. This includes:

• Testing your code on different types of applications
• Testing your code with multiple monitors (see the beginning of setupManager() to see how to fake multiple monitors in the nested session)
• Making sure your code is efficient and does not have obvious performance issues
• Make ABSOLUTE sure you are following the code styling and your code is not cluttered and/or unreadable. Use descriptive variable and function names, follow the naming convention, etc.