Repository navigation
doc: link to code style guide #12636
Description
Activity
I think in general we try to document our coding style in lint rules. I don't know how easy it would be to lint for this.
Yeah I was thinking about that (linting for header include)
Still maybe we should have a style-guide to save new devs one "code" -> "lint" -> "fix" cycle
Still maybe we should have a style-guide to save new devs one "code" -> "lint" -> "fix" cycle
The problem is that you then have to keep the style guide up to date with the linter. And I'm pretty sure the average dev would rather run the linter for each project than read the style guide, especially when you can just pass
--fixto autofix basic issues.Reacted by Refael AckermannSo I've been reading cpplint.py, and was reminded nodejs/node-v0.x-archive#8487 that it actualy linting acording to https://google.github.io/styleguide/cppguide.html, so may be a link, and some rules of thumb?
This should remain open? If so, maybe label
help wanted?Hi, @Divya063! Take a look at http://nodetodo.org/getting-started/ for one way to get a good first task to work on in Node.js core.
- added a commit that references this issue
on Oct 15, 2017 - added a commit that references this issue
on Jul 27, 2026
IMHO we should add a link to the Google Style Guide according to which me are linting C++
and add some Best Practices
After #12540 I thought we should add something like:
When editing C++
If you add a new macro or use a new external function, make sure you include the header file explicitly in the file you are editing. This makes sure your change is independent of previous changes, and makes it easier to backport