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

Get `plugin` javadoc to point to `lib`

Open
  • Is something wrong?
#5 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
java
Domain
build-system, documentation

Research direction

Start by inspecting how this repository publishes the plugin and lib Javadocs, using the linked ChangelogExtension example as the failing case. Determine why the plugin Javadoc does not resolve references to the lib Javadoc, then verify that the published links resolve correctly for matching plugin and lib versions.

Written by the indexing model from the issue text.

Description

bug

We publish the plugin and lib at the exact same time, and I can't figure out how to get the plugin javadoc to correctly point to the lib javadoc.

e.g. Changelog ChangelogExtension::getParsedChangelog()

Dominant language
Java
Stars
49
Forks
2
No merged PRs in 30d

Getting set up

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 diffplug/spotless-changelog

All issues in diffplug/spotless-changelog

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.