Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs on clang-tidy #70

Closed
springmeyer opened this issue Aug 25, 2017 · 1 comment
Closed

Docs on clang-tidy #70

springmeyer opened this issue Aug 25, 2017 · 1 comment

Comments

@springmeyer
Copy link
Contributor

springmeyer commented Aug 25, 2017

Add docs to the extended section on:

  • What is clang-tidy?
  • What kind of bugs does it catch?
  • How to run it locally: make tidy
  • When you see a failure, what do you do? (hint: clang-tidy outputs shorthand codes for each error/warning that can be googled to get to its individual page like https://clang.llvm.org/extra/clang-tidy/checks/performance-unnecessary-copy-initialization.html)
  • Add note that when forward porting node-cpp-skel to another existing node c++ addon, it is expected that you will hit clang-tidy errors. Fixing them can take some time, so some devs may wish to disable the travis job to be able to triage slowly.

Context: clang-tidy support landed in #64

@springmeyer springmeyer added this to the Phase 1 milestone Aug 29, 2017
@springmeyer springmeyer removed this from the Phase 1 milestone Dec 6, 2017
@GretaCB
Copy link
Contributor

GretaCB commented Jan 10, 2018

PR going over at #103

@GretaCB GretaCB closed this as completed Jan 10, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants