[doc] Document usage of checker-qual `@Nullable` as ADR
Open
Nobody has claimed this yet.
in:documentation
- Dominant language
- Java
- Stars
- 5.5k
- Forks
- 1.6k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 54
Description
Since PMD 7, we use the checker framework for null-checks.
We should write up guidelines as ADR, when to use @Nullable, when to use Optional.
See Optional vs. Nullable for details.
Also, we don't enforce it yet - so there are no checks active during build...
- When to use
@Nullable - When to use
@Nonnull
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 by reviewing the checker framework reference and the linked “Optional vs. Nullable” discussion, then find the repository’s existing ADR conventions. Document when to use checker-qual @Nullable, @Nonnull, and Optional, noting that checks are not yet enforced during the build. Done means the guidance is captured as an ADR and matches the project’s current nullability usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100