Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

README documents Java 8 as the minimum requirement, but the build targets Java 11

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

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
84/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
java
Domain
build-system, documentation

Research direction

Review the Minimum Requirements section in README.md, the maven-javadoc-plugin source setting in pom.xml, and the Java matrix in .github/workflows/integration.yml. Compare the documented and configured Java versions, then run the Maven build and integration workflow checks to confirm the README and Javadoc configuration consistently use Java 11.

Written by the indexing model from the issue text.

Description

The README documents a minimum requirement that the project no longer supports.

README.md (section Minimum Requirements) states:

Ensure you have Java 8 or higher installed.

However the build has targeted Java 11 for some time:

  • pom.xml configures maven-compiler-plugin with <release>11</release> (both in the main build and in the errorprone profile).
  • .github/workflows/integration.yml runs the compatibility matrix against java-version: [ '11', '17', '21' ] — Java 8 is never exercised.

Impact

A user who follows the README on a Java 8 toolchain hits a compilation failure with nothing pointing back at the documented requirement being wrong. <release>11</release> also means the published artifact carries class file major version 55, so Java 8 consumers cannot use the released jar either.

Additional inconsistency

maven-javadoc-plugin is still configured with <source>1.8</source> while the compiler targets 11, which is a leftover from the same migration.

Proposed fix

  • State Java 11 as the minimum requirement in the README.
  • Align the javadoc plugin's <source> with the compiler's <release>.

Happy to open a PR for this.

Dominant language
Java
Stars
9
Forks
4
Avg merge
1h 40m
Merged PRs (30d)
1

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.

More from zitadel/client-java

All issues in zitadel/client-java

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.