Document dependency syntax
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 68
- Forks
- 21
- Avg merge
- 2h 35m
- Merged PRs (30d)
- 3
Description
It's not clear from the README, but when using a Scala dependency, the author must be sure to append the Scala version explicitly, e.g.
javaAgents += "com.example" % "somelibrary_2.12" % "1.2.3" % "compile;runtime"
Using the %% syntax instead of _2.12 will appear to work, but the java agent will not be resolved, and the -javaagent parameter won't be provided.
I can think of a few remediations:
- Allow
%%to be used, which fixes the issue. - Document that
%%is not supported and update the README.
Either way, I think the plugin should print a warning or error when agents are not resolved: silent failure is frustrating and harder to debug.
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 with the README and review the dependency syntax around the javaAgents example. Confirm how the documented Scala dependency form differs from %% and state the supported form and its resolution limitation clearly. Done means a newcomer can determine which syntax to use without relying on silent behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- build-system
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100