jMonkeyEngine / jMonkeyEngine/sdk

Codacy rules

Open
#320 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
348
Forks
104
Avg merge
4d 13h
Merged PRs (30d)
3

Description

I think everyone agrees that Codacy is rather overzealous regarding some things. I logged in to se what options there are.

The purpose of this thread is to gather potential rules to omit and have a discussion around that.

I think requiring javadocs for fields is a bit too much. I think it's this one:

  • CheckStyle - JavadocMethod - Specify the access modifiers where Javadoc comments are checked.

  • JavaDoc param requiring an empty line (especially since it doesn't seem to work?) But I can't find which one that is. Would be great if it was linked in the issue.

Seems it's possible to configure through a file:
https://docs.codacy.com/repositories-configure/codacy-configuration-file/

Perhaps also changing the max allowed minimum errors. It would be nice though if some still showed up as warnings, but didn't fail the build, like magic numbers, java doc issues.

Contributor guide

No contributing guide indexed for this repository

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 with the Codacy configuration file documentation linked in the issue and review the CheckStyle JavadocMethod rule and the requested JavaDoc parameter rule. Determine which rules should be omitted or treated as warnings, and confirm how the maximum error threshold affects the build. Done means the proposed configuration and rule changes are agreed and documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
ci-cd
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.