ietf-tools / ietf-tools/draftforge

Checkers should ignore text in XML comments

Open
#82 1 comment 0 reactions 1 assignee View on GitHub

@NGPixel is already working on this.

Since Jun 4, 2026.

enhancement priority: normal
Dominant language
JavaScript
Stars
12
Forks
8
No merged PRs in 30d

Description

All the checkers, except for Typos and Repeated Words checkers, and the List tools (abbreviations, capitalization, and formatting) should skip scanning XML comments because the XML comments usually contain duplication of text that has already been flagged:

<!-- [rfced] In Section 2, the following terms are used inconsistently...

Current:
    /quoted text from Section 2 where ip address, IP Address, ipAddress, and IP-Address are used/

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.