Konloch / Konloch/bytecode-viewer

Use Git submodules for Krakatau and enjarify

Open
#364 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Currently Krakatau and enjarify are included as ZIP files (multiple times).

It might be better to use Git submodules instead. This would have the following advantages:

  • It is clearer which version is included.
    The current versioning uses version numbers which do not exist for that repository, e.g. Krakatau-11.zip; Krakatau does not seem to have any release versions or Git tags. Additionally the ZIP files do not seem to include information about which exact commit they contain.
  • They increase trust.
    I don't want to allege any bad intentions, but especially for new users of this project it would increase trust when they directly see which version of Krakatau and enjarify is included, instead of having to manually find out if the ZIP files are legit. This also makes it for the maintainers easier to see if pull requests from new contributors claiming to update these ZIP files have bad intentions.
  • It decreases the repository size.
    Instead of having to replace a binary ZIP file for every version update, only the Git submodule data has to be updated.

This might also make it easier to omit certain directories when building the bytecode-viewer JAR, such as the test, examples and documentation directories of Krakatau and enjarify (if their licenses permits this).

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 repeated Krakatau and enjarify ZIP files and the process that packages them into the bytecode-viewer JAR. Review the submodule workflow and verify the licenses before deciding whether test, examples, and documentation directories can be omitted. Done means the dependencies are referenced at exact commits, repository size is reduced, and the resulting JAR still builds correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, java
Domain
build-system, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.