redhat-developer / redhat-developer/lsp4ij

Add @ApiStatus.Internal annotation on non-API code

Open
#380 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

debt
Dominant language
Java
Stars
344
Forks
113
Avg merge
5h 22m
Merged PRs (30d)
15

Description

This is will make it easier to understand what is considered API or not.

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 by reviewing the Java source tree and locating the existing API boundaries and uses of ApiStatus, then identify code that is not part of the public API. Done means the intended non-API code is consistently marked with ApiStatus.Internal and the project’s relevant checks pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.