Konloch / Konloch/bytecode-viewer
Consistent code and language formatting
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 15.6k
- Forks
- 1.3k
- PR merge metrics
- No merged PRs in 30d
Description
Taking a peek at the codebase and strings these days I noticed a lot of inconsistent code syntax style/formatting (e.g., if (thing) vs. if(thing)). Though, I found a stale issue #422 about solving this already.
Additionally I have minor quibbles about certain terminology used in strings along the application. For example, Jar vs. JAR—Oracle and Wikipedia both use the styling of "JAR," so I think using that instead may be more proper. The same could also be said about ZIP, etc.
I also noticed the usage of two periods (..) versus three as a proper ellipses, which also raises the question whether three periods should be used (...), or Unicode's HORIZONTAL ELLIPSIS (…); personally, I like the latter.
Additionally I noticed that there may be some inconsistency with the grammar of translations. For example, in the Vietnamese translation file, many translation strings have a space before the ellipses but not the periods (e.g., "Lưu dưới dạng Zip ..." vs. "Mở..."). There also appear to be un-translated strings as well ("Save As Runnable Jar ..." in vietnamese.json).
I am willing to go through myself and fix the grammar bits, but I'm also curious what you think about code formatting (since #422).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the stale issue #422 and reviewing the codebase's formatting conventions, then inspect vietnamese.json for the cited translation inconsistencies. Define consistent code syntax, terminology, ellipsis usage, spacing, and translation coverage across the application; done means the agreed conventions are applied consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- developer-experience, localization
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100