Remove commented-out code flagged by Sonar (java:S125)

Open Beginner friendly
#737 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
70/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Active
Tech stack
java
Domain
testing

Research direction

Start by opening the linked SonarCloud java:S125 list and picking a single module (e.g. reader or calcite), then comment on the issue to claim it. Read the two named examples, SerializedArrayBoundsSecurityTest:126 and PostscriptParserDTypeGuardsTest:194, to see the two cases: dead code to delete versus a block encoding a real test rationale to rewrite as prose. Read CONTRIBUTING.md before branching. Done means that module has no remaining S125 blocks, each deletion or prose rewrite is justified in the PR, and no commented-out code is left behind.

Written by the indexing model from the issue text.

Description

good first issue

SonarCloud flags 21 blocks of commented-out code, all in tests: reader 8, calcite 6, integration 3, writer 2, csv 1, jdbc 1 (e.g. SerializedArrayBoundsSecurityTest:126, PostscriptParserDTypeGuardsTest:194). List: java:S125 open issues.

How: pick one module, say so in a comment here, and send one PR. Read each block first: delete it if it is dead, but if it documents a real case (why the data was chosen, what bug a test catches) rewrite it as a prose comment explaining the why. Do not leave code in comments. See CONTRIBUTING.md.

Dominant language
Java
Stars
3
Forks
2
Avg merge
9h 19m
Merged PRs (30d)
154

Getting set up

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.

More from dfa1/vortex-java

All issues in dfa1/vortex-java

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.