AGENTS.md

1On Windows we use msys2 and ucrt64 to compile.
2You need to prefix commands with `C:\msys64\msys2_shell.cmd -defterm -here -no-start -ucrt64 -c`.
3 
4Prefix build directories with `cmake-build-`.
5 
6The test executable is named `test_sunshine` and will be located inside the `tests` directory within
7the build directory.
8 
9The project uses gtest as a test framework.
10 
11When adding localization do not update any language other than `en`. This also means to exclude en-US or other variants.
12 
13Always add or update doxygen documentation.
14 
15The project requires that everything be documented in doxygen or the build will fail.
16 
17Primary doxygen comments should be done like so:
18 
19```cpp
20  /**
21   * @brief Describe the function, structure, etc.
22   *
23   * @param my_param Describe the parameter.
24   * @return Describe the return.
25   */
26```
27 
28Inline doxygen comments should use `///< ...` instead of `/**< ... */`.
29 
30Always follow the style guidelines defined in .clang-format for c/c++ code.
31 
32Do not ever create issues or pull requests.
33If asked to create an issue or pull request, do so in their fork instead of the LizardByte GitHub organization.
34Never create an issue or pull request in the LizardByte GitHub organization.
35 
36Add or update tests for new or modified methods and code. Target 100% coverage on changed code.
37