Skip to content

docs: add JSpecify nullness guidelines to AGENTS.md #13881

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nnicolee merged 2 commits into from
Jul 27, 2026
Merged

docs: add JSpecify nullness guidelines to AGENTS.md #13881

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45fa599
feat: add JSpecify nullness guidelines to AGENTS.md
nnicolee Jul 23, 2026
a7e54dc
updated context as per comments
nnicolee Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,34 @@ This is a standard Maven project.
4. Avoid unnecessary formatting changes to keep diffs clean.
5. Use `mvn` for everything other than the `test/integration` folder.

## 5. Dependency Management
## 5. JSpecify Nullness Guidelines
Comment thread
nnicolee marked this conversation as resolved.
Outdated
To enforce compile-time null-safety and eliminate NullPointerExceptions, this repository is adopting JSpecify 1.0 annotations.
Comment thread
nnicolee marked this conversation as resolved.
Outdated

### 5.1 Dependency Requirement
Before adding nullability annotations to any module, you must ensure the JSpecify dependency is declared in the module's `pom.xml`
Comment thread
nnicolee marked this conversation as resolved.
Outdated
Comment thread
nnicolee marked this conversation as resolved.
Outdated

### 5.2 Handwritten vs. Generated Code Handling
- **Handwritten Modules**: Annotations are added to source files directly.
- **Generated Modules**: Do not edit generated class files manually! Instead, update the code generator engine (`gapic-generator-java`) to automatically produce the annotations during the generation phase.

### 5.3 Annotation Usage & Type-Use Semantics
Prefer JSpecify annotations (`org.jspecify.annotations.NullMarked` and `org.jspecify.annotations.Nullable`) over legacy declaration annotations (like `javax.annotation.Nullable`).
- **Default semantics**: Annotate classes with `@NullMarked` to declare that all unannotated types exclude null.
- **Type-Use Placement Rules**: JSpecify annotations are type-use annotations. They must be placed in the type-use position:
- **Generics**: `List<@Nullable String> list` (non-null list containing nullable String elements).
- **Arrays**: `String @Nullable [] array` (nullable reference to an array).
Comment thread
nnicolee marked this conversation as resolved.
Outdated
- **Fully-Qualified**: `com.google.auth.oauth2.@Nullable TokenVerifier` (place immediately before the simple class name).
Comment thread
nnicolee marked this conversation as resolved.
Outdated

## 6. Dependency Management
- Do not bump external dependency versions unless for CVE or critical bug fix.
- Avoid introducing new external dependencies if possible. Prefer Java standard library, then opt for existing dependencies.

## 6. Contribution Guidelines
## 7. Contribution Guidelines
- **Commits**: Conventional Commits `<type>(<scope>): <description>`.
- **Pull Requests**: Submitted via PR, require review. Pull latest from main and resolve conflicts.
- **Testing**: All new logic should be accompanied by tests.

## 7. Specialized Development Guides
## 8. Specialized Development Guides
For development on core components, refer to the following guides in `sdk-platform-java`:
- **GAPIC Generator**: [sdk-platform-java/gapic-generator-java/DEVELOPMENT.md](sdk-platform-java/gapic-generator-java/DEVELOPMENT.md)
- **GAX**: [sdk-platform-java/gax-java/DEVELOPMENT.md](sdk-platform-java/gax-java/DEVELOPMENT.md)
Loading