[Maintenance]: Change nullability annotations
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 52/100
- Issue type
- Refactor
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- java
- Domain
- build-system
Research direction
Find the project's dependency declarations and Java sources using javax.annotation.Nullable or javax.annotation.Nonnull. Start by checking how dependencies are managed and searching for those annotation uses. Add JSpecify, replace the annotations, and remove jsr305; done when the project builds with all usages migrated and the old dependency removed.
Written by the indexing model from the issue text.
Description
Describe the problem
So far, we have been using javax.annotation.Nullable and javax.annotation.Nonnull whereever we using nullability annotations. These are great for things like return and parameter types, but have limited uses elsewhere.
Also, despite living under javax, these are not standard annotations as JSR-305 was never accepted. The annotations are instead provided by com.google.code.findbugs:jsr305:3.0.2, which is not being kept up-to-date with language changes (no update since 2017).
The improvement you'd like to see
- Add a dependency on
org.jspecify:jspecify. - Replace uses of
javax.annotations.Nullablewithorg.jspecify.annotations.Nullable - Replace uses of
javax.annotations.Nonnullwithorg.jspecify.annotations.NonNull - Remove the dependency on
com.google.code.findbugs:jsr305
Expected Benefits
We'll have nullability annotations that can be used in most contexts (e.g., generics) from a library that is maintained and can react to language changes (even though releases are rarely needed).
Additional Context
No response
- Dominant language
- Java
- Stars
- 927
- Forks
- 286
- Avg merge
- 3d 17h
- Merged PRs (30d)
- 94
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from RPTools/maptool
-
[Bug]: An initiative list with no current entry logs an error on every changePossibly taken @dwizard0 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
[Maintenance]: Migrate gradle dependency submission to modern alternativePossibly taken @VelpulaGangavardhan claimed this 18 days ago. Opencode-maintenance
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
RPTools/maptool#6156 · 2 comments · 1 assignee ·
Maintainers usually reply within 1 day
-
code-maintenance
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
Similar issues
-
Cleanup: restore the interrupt flag in AiFailureAnalyzerPossibly taken @Rishankgupta08 claimed this today. Opengood first issue
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
seleniumboot/selenium-boot#258 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
johanhaleby/occurrent#1505 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
FasterXML/jackson-databind#6443 ·
Maintainers usually reply within 1 day
-
Docs: 2 broken linksOpen
Difficulty 1/5 Under an hour Newbie friendliness 78/100
Maintainers usually reply within 1 day