Document how to test custom checks

Open Beginner friendly
#3,554 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-2 days
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
java
Domain
documentation

Research direction

Start with the custom checks documentation at https://errorprone.info/docs/plugins and review the linked discussion for the testing and JVM-argument details. Document how to use error_prone_test_helpers and CompilationTestHelper, plus the required build-tool configuration; the page is done when a newcomer can follow it to test a custom check.

Written by the indexing model from the issue text.

Description

The documentation for writing your own checks (https://errorprone.info/docs/plugins) should explain how to test them using error_prone_test_helpers and CompilationTestHelper, and how to configure your build tool with the appropriate JVM arguments.

See https://github.com/tbroyer/gradle-errorprone-plugin/discussions/75

Dominant language
Java
Stars
7.2k
Forks
821
Avg merge
17h 27m
Merged PRs (30d)
45

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.

More from google/error-prone

All issues in google/error-prone

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.