line / line/centraldogma

Use Error Prone's annotations for better static analysis

Open
#660 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

improvement
Dominant language
Java
Stars
668
Forks
135
Avg merge
4d 19h
Merged PRs (30d)
7

Description

A `Watcher` should be closed after using it. `@MustBeClosed` in Error Prone is useful to warn users and IDE to close it explicitly.
https://errorprone.info/api/latest/com/google/errorprone/annotations/MustBeClosed.html

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

Find the Watcher definition and read how callers obtain and use it. Review Error Prone's @MustBeClosed documentation at the linked URL, then determine where the annotation belongs so static analysis can flag unclosed Watchers. Done means the relevant API is annotated and the existing build or analysis checks pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.