Konloch / Konloch/bytecode-viewer

Consider adding automatic formatting

Open
#422 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Discussion Enhancement
Dominant language
Java
Stars
15.6k
Forks
1.3k
PR merge metrics
No merged PRs in 30d

Description

While working with the codebase I found the codestyle across files to be quite incosistent. This probably results from no well-defined code style. I think it would be worthwhile to configure a plugin like https://github.com/diffplug/spotless/tree/main/plugin-maven to automatically apply formatting through a maven task. This would also allow to enforce the codestyle through a CI task.
Any thoughts?

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 reviewing the Maven build configuration and existing CI setup to determine where formatting and verification tasks would fit. Clarify the desired code style and formatting scope, then assess whether the plugin can apply it consistently and enforce it in CI.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, ci-cd
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.