getodk / getodk/docs

Investigate and improve the style-guide checks to reduce false positives

Open
#471 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

In reference to #94, #427.
Improved regex or testing approach for checks which are generating too many false positives.
**Any PR for this issue should use the tag ``Addresses`` instead of ``closes``.**

Contributor guide

Open the contributing guide

Research direction

Start by reading the issue's references, #94 and #427, then locate the style-guide checks responsible for the reported false positives. Review their regexes and current testing approach; done means the checks produce fewer false positives and the changed behavior is covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.