nodejs / nodejs/citgm

Add comments for skip and flaky

Open
#568 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
606
Forks
157
Avg merge
3d 23h
Merged PRs (30d)
3

Description

Right now it is super hard to know why modules are skipped or why they are marked as flaky. It would be great to change our JSON format to a JS file and to then add comments to each entry.

That way it would be easier to know when it is fine to remove such a entry again.

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.

Research direction

Start by locating the JSON data that defines skipped and flaky modules and the code that loads it. Review how every entry is represented, then convert the format to a JavaScript file with explanatory comments; done means the entries remain usable and the existing test workflow passes.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
testing-qa, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.