Skip to content

doc: document C++ formatting in the pull request guide - #67205

Open
inoway46 wants to merge 1 commit into
nodejs:mainfrom
inoway46:doc-cpp-format-guide
Open

inoway46 wants to merge 1 commit into
nodejs:mainfrom
inoway46:doc-cpp-format-guide

Conversation

@inoway46

@inoway46 inoway46 commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

The pull request guide recommends make lint, which does not include the C/C++ formatting check run by CI. Document how to install and run the formatter and remind contributors to commit any formatting changes.

This is especially helpful for first-time contributors, whose CI runs may require approval. Running the formatter locally lets them catch formatting issues before waiting for CI.

Refs: #66834 (comment)

Document formatter setup and usage separately from make lint so
contributors can catch C/C++ formatting issues before CI runs.

Refs: nodejs#66834 (comment)
Assisted-by: Codex
Signed-off-by: inoway46 <inoueyuya416@gmail.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to Node.js documentation. label Nov 2, 2026
@inoway46 inoway46 added author ready PRs with CI started, the required approvals, and no outstanding review comments. commit-queue PRs queued for automated landing through the Commit Queue. labels Nov 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. commit-queue PRs queued for automated landing through the Commit Queue. doc Issues and PRs related to Node.js documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants