typetools / typetools/checker-framework

Improve dependency on com.google.errorprone:javac

Open
#3,213 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
1.1k
Forks
440
Avg merge
1d 12h
Merged PRs (30d)
134

Description

https://checkerframework.org/manual/#maven does not explain what the com.google.errorprone:javac dependency is needed for.

If it is a Java compiler, it seems odd to be a runtime dependency.
If it is a dependency of the Checker Framework itself, which runs as an annotation processor, it should be a dependency in the section. Even better, org.checkerframework:checker (as supplied in should itself declare its dependency on javac.

Another, minor point: The section declares true. It shouldn't do that, it's the responsibility of the respective release engineer to decide whether forking is a good idea or not - unless Checker Framework explicitly requires a fork, in which case the configuration snippet should explain why.

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 with the Maven section at https://checkerframework.org/manual/#maven and inspect how com.google.errorprone:javac, annotationProcessorPaths, and the fork setting are presented. Confirm the dependency and fork requirements, then update the documentation so their purpose, placement, and any required behavior are explicit.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.