cpp-linter / cpp-linter-action

A Github Action for linting C/C++ code integrating clang-tidy and clang-format to collect feedback provided in the form of file-annotations, thread-comments, workflow step-summary, and Pull Request reviews.

Home Page:https://cpp-linter.github.io/cpp-linter-action/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

create an examples folder to demonstrate various usage

2bndy5 opened this issue · comments

It would be a good idea to have an examples folder (with a README in it) that demonstrates how to use commonly desirable configurations.

Example ideas include:

  • run clang-tidy only
  • run clang-format only
  • apply thread-comments to only pull requests in workflows that also trigger on push events (similar to example in root README)
  • cpp-linter/cpp-linter#82

Originally posted by @2bndy5 in #193 (comment)

So we will have two folders? One is demo and another is examples? How about move folder demo to examples

Yeah, we could do that.