Contributing

  • ln-libra-cxx-dev-guide

  • ln-libra-git-commit-guide

  • ln-libra-git-issue-guide

Workflow

For the general contribution workflow, see the docs over in ln-libra-dev-workflow.

For the static analysis step:

  1. Run static analysis on the code:

    make static-check-all
    

    Pay special attention to files that you have changed. Fix anything the static analyzers flag.

    If you are feeling REALLY adventurous, you can run this one on the code too, which takes much longer:

    make cppcheck-all
    
  2. Run the style checker on the code:

    make tidy-check-all
    

    Not everything flagged should/can be fixed, so only pay attention to things that it flags in code YOU have changed. If you aren’t sure, ask someone.

  3. Run the clang formatter on the code to fix any formatting things you may have inadverdently missed:

    make format-all