Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

38 lines (24 loc) · 1.37 KB

Contribution guidelines

Feel free to open an issue with your comments / encountered bugs / requests for features.

In case you want to contribute a PR, please open an issue first with a bit of details about the planned change or comment on an existing issue that you want to work on it.

The repository mostly uses the Google C++ style guide.

clang-format

Formatting is checked when you make a PR, please format your files with the included .clang-format configuration. Use the provided scripts for your convenience:

/misc/scripts/format.ps1
/misc/scripts/format.sh

clang-tidy

Static analysis is checked when you make a PR, please make sure there are 0 clang-tidy warnings in your code, using the included .clang-tidy configutaion. Use the provided scripts for your convenience:

/misc/scripts/tidy.ps1
/misc/scripts/tidy.sh

Clang tools versions

The CI currently works with the clang-18 tools from the Ubuntu 24.04 runner

Copyright

Feel free to add your copyright to the files you modify by adding this comment:

// SPDX-FileCopyrightText: year name

You can also add yourself to the list of authors shown in the app (about.cc).