hyprland-wiki/pages/Contributing and Debugging/PR-Guidelines.md
Mihai Fufezan 127ae00225 wiki: prepare for hextra
treewide: replace hint with callout

treewide: remove ToC header

remove <toc>, since it's autogenerated
add missing _index.md

treewide: add frontmatter

treewide: fix headings

add weights

Configuring,Getting Started: expand in sidebar

Add version selector

fix links
2024-03-14 22:47:27 +02:00

776 B

title
PR Guidelines

PR Requirements

  • Clean, not hacky code
  • Described changes and why they were there
  • Following the style (see below)

Code Style

Hyprland's code style is governed by the .clang-format file.

Make sure to format accordingly whenever you make a PR.

Some code FAQ

Why is the config variable getting so weird?

Every variable from the config needs to be found in a hashmap. To limit the amount of hashmap searches, getting a config option looks like this:

static auto* const PFOLLOWMOUSE = &g_pConfigManager->getConfigValuePtr("input:follow_mouse")->intValue;

Since the hashmap cannot be mutated during runtime, this pointer will always be valid, and will not require hashmap lookups every single time it's read.