Start-Out/todo-or-not

Adjust grammar to discard any TODO with a letter before it

Open

#399 opened on Sep 23, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (5 forks)auto 404
buggood first issuetodo-grammar

Repository metrics

Stars
 (5 stars)
PR merge metrics
 (PR metrics pending)

Description

for example:

* 50:	        /// Does damage to the user, then resets damageToDo and critToDo
  51:	        void handleDamageToDo(Actor* user);
  52:	};

should not be a hit

Contributor guide

Research direction
Find the grammar definition for TODO detection, inspect how it currently matches the word TODO, and modify the rule to require that TODO is not preceded by a letter.
Tech stack
python
Domain
developer experiencetooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75