Skip to content
IonWarpTry for free
Nit meaning in code review

Nit meaning in code review: what a nit is, with examples

A nit, short for nitpick, is a minor code review comment the author may choose to skip: a name, a typo, a blank line. Google's review guide tells reviewers to start such a comment with "Nit:" so the author knows it is "just a point of polish that they could choose to ignore".[1] IonWarp, an AI reviewer for GitHub pull requests, lists the findings that can wait as nitpicks.

Example pull request#310

What lands on your pull request · Code Review

P1Retry charges the same order twice
billing/checkout.ts:42 · A timed-out response can charge the order twice
- await payments.charge(order);+ await payments.charge(order, {+   idempotencyKey: order.id,+ });
When payment succeeds but the response times out, the caller retries the same order. Both calls charge it. Pass the stable order ID as the payment idempotency key.

A nit does not block a merge by itself: left in a Comment review, it neither approves the change nor requests changes.[2] The exception is a protected branch that requires conversation resolution, where every thread, nits included, must be resolved before merging.[3] Code review terms covers what PTAL means, SGTM and the rest of the shorthand.

What a nit looks like

  • A name

    "nit: this holds a map, not a list; usersById would say so." The code runs the same either way; the next reader understands it sooner.

  • A typo

    "nit: recieve → receive", in a log line, a docstring or an error message a user never sees.

  • A preference

    The order of two imports, an early return, a blank line. Google's guide calls any style point its style guide does not cover a matter of personal preference.[1]

  • Not a nit

    A missing check, a test that cannot fail, a secret written to a log. Each can let a real failure through, so it is not optional and should not carry the label. Code review best practices separate these from suggestions.

How to leave a nit, and how to answer one

  1. Label it

    Google's comment guide offers three labels: Nit, a minor thing that "won't hugely impact things"; Optional or Consider, a good idea that is not strictly required; and FYI, something to think about later. Without labels, authors may read every comment as mandatory.[4]

  2. Or use Conventional Comments

    Its nitpick: label is for "trivial preference-based requests" that "should be non-blocking by nature", and a (non-blocking) decoration marks any other label the same way.[5]

  3. Make it one click

    Put the fix in a suggestion block. The author clicks Commit suggestion, or adds several to a batch and commits them together.[6]

  4. Answer every one

    Fix it, or reply that you will leave it. If it is outside the pull request's scope, open an issue to track it.[6]

  5. Hand formatting to a tool

    A whitespace or formatting nit is one a formatter or linter in CI can make on every pull request, so no reviewer has to.

  6. How IonWarp marks its nits

    Every finding is P0, P1 or P2. A P2 is real but can wait, and the review comment lists it as a nitpick; by default a P0 sets the GitHub check to Action required. Anyone with write access can reply "@ionwarp learn:" and one sentence, such as "formatting is CI's job", and every reviewer of the project reads it on the next pull request.

    Code ReviewOn Starter, Pro and Max

Pricing

Simple pricing for your whole team.

One workspace price with seats included. Credits pool across your team. Unlimited repos on every plan.

Starter

$0 /mo

Try AI PR review.

  • 2 reviewers
    • Code Review
    • Security Review
  • 3 seats included
  • 15,000 credits to start, then 5,000/mo
  • About 70 reviews to start, then about 25 a month
  • Unlimited repos
Get Started

Max

$149 /mo

Scale AI PR review.

  • +9 reviewers
    • UX Review
    • API Performance
    • Analytics Review
    • SEO Review
    • Changelog
    • CI/CD Performance
    • Plan Review
    • Repeat-Failure Learnings
    • SOC 2 Review
  • 10 seats included
  • +75,000 credits/mo
  • About 360 reviews a month
  • +$29/mo per added seat
  • Unlimited repos
  • Priority support
Choose Max
Enterprise

Custom reviewers + credits · GitHub Enterprise · SSO/SAML + audit logs · Custom security review + SLA

Contact us
FAQ

Frequently asked questions

What does nit mean in code review?

Nit is short for nitpick: a minor comment the author may choose to skip, such as a name or a typo. Starting the comment with "Nit:" tells the author it is optional.

Do I have to fix a nit?

No. Fix it if it takes a minute, or reply that you will leave it. On a branch that requires conversation resolution, resolve the thread either way before merging.

Can a nit block a merge on GitHub?

Not by itself: a Comment review neither approves nor requests changes. A protected branch that requires conversation resolution does hold the merge until every thread is resolved, nits included.

What is the difference between a nit and a suggestion?

In Conventional Comments, a suggestion proposes an improvement and says why it is one; a nitpick is a trivial, preference-based request that should not block. Either can be marked non-blocking.

Does IonWarp leave nits?

It labels them. Every finding is P0, P1 or P2; a P2 is real but can wait, and the review comment lists it as a nitpick. By default a P0 sets IonWarp's GitHub check to Action required.

Sources

  1. The Standard of Code ReviewGoogle · read
  2. Pull request reviewsGitHub Docs · read
  3. About protected branchesGitHub Docs · read
  4. How to write code review commentsGoogle · read
  5. Conventional CommentsConventional Comments · read
  6. Incorporating feedback in your pull requestGitHub Docs · read