Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

28 lines (23 loc) · 1.64 KB

Preface

LUS accepts any and all contributions. You can interact with the project via PRs, issues, email ([email protected]), or Discord.

Code of Conduct

Please review and abide by our code of conduct.

Building

Please see the readme for building instructions.

Pull Requests

Procedures

Our CI system will automatically check your PR to ensure that it fits formatting guidelines, linter guidelines, and that the code builds. The submitter of a PR is required to ensure their PR passes all CI checks. The submitter of the PR is encouraged to address all PR review comments in a timely manner to ensure a timely merge of the PR.

Troubleshooting CI Errors

tidy-format-validation

If the tidy-format-validation check fails, then you need to run clang-format. Below is a command that can be used on Linux. Most modern IDEs have a clang-format plugin that can be used. The .clang-format file can be found here

Running clang-format
From within the LUS directory.

Ensure clang-format-14 is installed and available through your system path.

Bash:

find src include -name "*.cpp" -o -name "*.h" | sed 's| |\\ |g' | xargs clang-format-14 -i

Powershell:

Get-ChildItem -Recurse -Path .\src -Include *.cpp, *.h -File | ForEach-Object { clang-format-14.exe -i $_.FullName }