Skip to content

Latest commit

 

History

History
30 lines (28 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

30 lines (28 loc) · 1.17 KB
Raw

Contributing to linux-enable-ir-emitter

Thank you for considering contributing to our project! We appreciate your interest and effort in improving linux-enable-ir-emitter. Please follow the guidelines below to ensure a smooth contribution process.

Reporting Issues

Before opening a new issue, please check the docs first in order to either find answer to your question or to use the right template.

Contributing Code

To be sure that the modifications you made to the code will pass the CI during the PR, please perform the following steps:

  1. Compile locally the dependencies: 
    cd .github/workflows/deps && cmake -GNinja -B build && ninja -C build && cd -
  2. Setup the build: 
    meson setup build --buildtype=debug --libdir=lib --prefer-static --pkg-config-path=$(find . -name "pkgconfig")`
  3. Compile: 
    meson compile −C build
    your new version of linux-enable-ir-emitter is located in build/src/
  4. Format the files: 
    ninja clang-format -C build
  5. Ensure clang-tidy pass: 
    ninja clang-tidy -C build
  6. Commit, push and please describe enough what you did in your PR description