mirror of
https://github.com/hyprwm/hyprland-wiki.git
synced 2024-12-02 00:45:58 +01:00
127ae00225
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
29 lines
776 B
Markdown
29 lines
776 B
Markdown
---
|
|
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:
|
|
|
|
```cpp
|
|
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.
|